blob: cc7c60e8f277805c0dff71be8fbf49f26dbd8e1d [file] [log] [blame]
Alex Eldere2a58ee2013-04-30 00:44:33 -05001
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002/*
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
Yehuda Sadehdfc56062010-11-19 14:51:04 -080025 For usage instructions, please refer to:
Yehuda Sadeh602adf42010-08-12 16:11:25 -070026
Yehuda Sadehdfc56062010-11-19 14:51:04 -080027 Documentation/ABI/testing/sysfs-bus-rbd
Yehuda Sadeh602adf42010-08-12 16:11:25 -070028
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>
Yehuda Sadeh59c2be12011-03-21 15:10:11 -070035#include <linux/parser.h>
Alex Elder30d1cff2013-05-01 12:43:03 -050036#include <linux/bsearch.h>
Yehuda Sadeh602adf42010-08-12 16:11:25 -070037
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>
Alex Elder1c2a9df2013-05-01 12:43:03 -050043#include <linux/slab.h>
Yehuda Sadeh602adf42010-08-12 16:11:25 -070044
45#include "rbd_types.h"
46
Alex Elderaafb2302012-09-06 16:00:54 -050047#define RBD_DEBUG /* Activate rbd_assert() calls */
48
Alex Elder593a9e72012-02-07 12:03:37 -060049/*
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
Alex Eldera2acd002013-05-08 22:50:04 -050058/*
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
Alex Elderf0f8cef2012-01-29 13:57:44 -060091#define RBD_DRV_NAME "rbd"
92#define RBD_DRV_NAME_LONG "rbd (rados block device)"
Yehuda Sadeh602adf42010-08-12 16:11:25 -070093
94#define RBD_MINORS_PER_MAJOR 256 /* max minors per blkdev */
95
Alex Elderd4b125e2012-07-03 16:01:19 -050096#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
Alex Elder35d489f2012-07-03 16:01:19 -0500100#define RBD_MAX_SNAP_COUNT 510 /* allows max snapc to fit in 4KB */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700101
102#define RBD_SNAP_HEAD_NAME "-"
103
Alex Elder9682fc62013-04-30 00:44:33 -0500104#define BAD_SNAP_INDEX U32_MAX /* invalid index into snap array */
105
Alex Elder9e15b772012-10-30 19:40:33 -0500106/* 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)
Alex Elder1e130192012-07-03 16:01:19 -0500108#define RBD_IMAGE_ID_LEN_MAX 64
Alex Elder9e15b772012-10-30 19:40:33 -0500109
Alex Elder1e130192012-07-03 16:01:19 -0500110#define RBD_OBJ_PREFIX_LEN_MAX 64
Alex Elder589d30e2012-07-10 20:30:11 -0500111
Alex Elderd8891402012-10-09 13:50:17 -0700112/* Feature bits */
113
Alex Elder5cbf6f122013-04-11 09:29:48 -0500114#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)
Alex Elderd8891402012-10-09 13:50:17 -0700118
119/* Features supported by this (client software) implementation. */
120
Alex Elder770eba62012-10-25 23:34:40 -0500121#define RBD_FEATURES_SUPPORTED (RBD_FEATURES_ALL)
Alex Elderd8891402012-10-09 13:50:17 -0700122
Alex Elder81a89792012-02-02 08:13:30 -0600123/*
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 */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700129#define DEV_NAME_LEN 32
Alex Elder81a89792012-02-02 08:13:30 -0600130#define MAX_INT_FORMAT_WIDTH ((5 * sizeof (int)) / 2 + 1)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700131
132/*
133 * block device image metadata (in-memory version)
134 */
135struct rbd_image_header {
Alex Elderf35a4de2013-05-06 09:51:29 -0500136 /* These six fields never change for a given rbd image */
Alex Elder849b4262012-07-09 21:04:24 -0500137 char *object_prefix;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700138 __u8 obj_order;
139 __u8 crypt_type;
140 __u8 comp_type;
Alex Elderf35a4de2013-05-06 09:51:29 -0500141 u64 stripe_unit;
142 u64 stripe_count;
143 u64 features; /* Might be changeable someday? */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700144
Alex Elderf84344f2012-08-31 17:29:51 -0500145 /* The remaining fields need to be updated occasionally */
146 u64 image_size;
147 struct ceph_snap_context *snapc;
Alex Elderf35a4de2013-05-06 09:51:29 -0500148 char *snap_names; /* format 1 only */
149 u64 *snap_sizes; /* format 1 only */
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700150};
151
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500152/*
153 * An rbd image specification.
154 *
155 * The tuple (pool_id, image_id, snap_id) is sufficient to uniquely
Alex Elderc66c6e02012-11-01 08:39:26 -0500156 * 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).
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500176 */
177struct rbd_spec {
178 u64 pool_id;
Alex Elderecb4dc22013-04-26 09:43:47 -0500179 const char *pool_name;
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500180
Alex Elderecb4dc22013-04-26 09:43:47 -0500181 const char *image_id;
182 const char *image_name;
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500183
184 u64 snap_id;
Alex Elderecb4dc22013-04-26 09:43:47 -0500185 const char *snap_name;
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500186
187 struct kref kref;
188};
189
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700190/*
Alex Elderf0f8cef2012-01-29 13:57:44 -0600191 * an instance of the client. multiple devices may share an rbd client.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700192 */
193struct rbd_client {
194 struct ceph_client *client;
195 struct kref kref;
196 struct list_head node;
197};
198
Alex Elderbf0d5f502012-11-22 00:00:08 -0600199struct 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
Alex Elder9969ebc2013-01-18 12:31:10 -0600207enum obj_request_type {
208 OBJ_REQUEST_NODATA, OBJ_REQUEST_BIO, OBJ_REQUEST_PAGES
209};
Alex Elderbf0d5f502012-11-22 00:00:08 -0600210
Alex Elder926f9b32013-02-11 12:33:24 -0600211enum obj_req_flags {
212 OBJ_REQ_DONE, /* completion flag: not done = 0, done = 1 */
Alex Elder6365d332013-02-11 12:33:24 -0600213 OBJ_REQ_IMG_DATA, /* object usage: standalone = 0, image = 1 */
Alex Elder5679c592013-02-11 12:33:24 -0600214 OBJ_REQ_KNOWN, /* EXISTS flag valid: no = 0, yes = 1 */
215 OBJ_REQ_EXISTS, /* target exists: no = 0, yes = 1 */
Alex Elder926f9b32013-02-11 12:33:24 -0600216};
217
Alex Elderbf0d5f502012-11-22 00:00:08 -0600218struct rbd_obj_request {
219 const char *object_name;
220 u64 offset; /* object start byte */
221 u64 length; /* bytes from offset */
Alex Elder926f9b32013-02-11 12:33:24 -0600222 unsigned long flags;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600223
Alex Elderc5b5ef62013-02-11 12:33:24 -0600224 /*
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 };
Alex Elderbf0d5f502012-11-22 00:00:08 -0600249 u32 which; /* posn image request list */
250
251 enum obj_request_type type;
Alex Elder788e2df2013-01-17 12:25:27 -0600252 union {
253 struct bio *bio_list;
254 struct {
255 struct page **pages;
256 u32 page_count;
257 };
258 };
Alex Elder0eefd472013-04-19 15:34:50 -0500259 struct page **copyup_pages;
Alex Elderebda6402013-05-10 16:29:22 -0500260 u32 copyup_page_count;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600261
262 struct ceph_osd_request *osd_req;
263
264 u64 xferred; /* bytes transferred */
Sage Weil1b83bef2013-02-25 16:11:12 -0800265 int result;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600266
267 rbd_obj_callback_t callback;
Alex Elder788e2df2013-01-17 12:25:27 -0600268 struct completion completion;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600269
270 struct kref kref;
271};
272
Alex Elder0c425242013-02-08 09:55:49 -0600273enum img_req_flags {
Alex Elder9849e982013-01-24 16:13:36 -0600274 IMG_REQ_WRITE, /* I/O direction: read = 0, write = 1 */
275 IMG_REQ_CHILD, /* initiator: block = 0, child image = 1 */
Alex Elderd0b2e942013-01-24 16:13:36 -0600276 IMG_REQ_LAYERED, /* ENOENT handling: normal = 0, layered = 1 */
Alex Elder0c425242013-02-08 09:55:49 -0600277};
278
Alex Elderbf0d5f502012-11-22 00:00:08 -0600279struct rbd_img_request {
Alex Elderbf0d5f502012-11-22 00:00:08 -0600280 struct rbd_device *rbd_dev;
281 u64 offset; /* starting image byte offset */
282 u64 length; /* byte count from offset */
Alex Elder0c425242013-02-08 09:55:49 -0600283 unsigned long flags;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600284 union {
Alex Elder9849e982013-01-24 16:13:36 -0600285 u64 snap_id; /* for reads */
Alex Elderbf0d5f502012-11-22 00:00:08 -0600286 struct ceph_snap_context *snapc; /* for writes */
Alex Elder9849e982013-01-24 16:13:36 -0600287 };
288 union {
289 struct request *rq; /* block request */
290 struct rbd_obj_request *obj_request; /* obj req initiator */
Alex Elderbf0d5f502012-11-22 00:00:08 -0600291 };
Alex Elder3d7efd12013-04-19 15:34:50 -0500292 struct page **copyup_pages;
Alex Elderebda6402013-05-10 16:29:22 -0500293 u32 copyup_page_count;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600294 spinlock_t completion_lock;/* protects next_completion */
295 u32 next_completion;
296 rbd_img_callback_t callback;
Alex Elder55f27e02013-04-10 12:34:25 -0500297 u64 xferred;/* aggregate bytes transferred */
Alex Eldera5a337d2013-01-24 16:13:36 -0600298 int result; /* first nonzero obj_request result */
Alex Elderbf0d5f502012-11-22 00:00:08 -0600299
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) \
Alex Elderef06f4d32013-02-08 09:55:48 -0600307 list_for_each_entry(oreq, &(ireq)->obj_requests, links)
Alex Elderbf0d5f502012-11-22 00:00:08 -0600308#define for_each_obj_request_from(ireq, oreq) \
Alex Elderef06f4d32013-02-08 09:55:48 -0600309 list_for_each_entry_from(oreq, &(ireq)->obj_requests, links)
Alex Elderbf0d5f502012-11-22 00:00:08 -0600310#define for_each_obj_request_safe(ireq, oreq, n) \
Alex Elderef06f4d32013-02-08 09:55:48 -0600311 list_for_each_entry_safe_reverse(oreq, n, &(ireq)->obj_requests, links)
Alex Elderbf0d5f502012-11-22 00:00:08 -0600312
Alex Elderf84344f2012-08-31 17:29:51 -0500313struct rbd_mapping {
Alex Elder99c1f082012-08-30 14:42:15 -0500314 u64 size;
Alex Elder34b13182012-07-13 20:35:12 -0500315 u64 features;
Alex Elderf84344f2012-08-31 17:29:51 -0500316 bool read_only;
317};
318
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700319/*
320 * a single device
321 */
322struct rbd_device {
Alex Elderde71a292012-07-03 16:01:19 -0500323 int dev_id; /* blkdev unique id */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700324
325 int major; /* blkdev assigned major */
326 struct gendisk *disk; /* blkdev's gendisk and rq */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700327
Alex Eldera30b71b2012-07-10 20:30:11 -0500328 u32 image_format; /* Either 1 or 2 */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700329 struct rbd_client *rbd_client;
330
331 char name[DEV_NAME_LEN]; /* blkdev name, e.g. rbd3 */
332
Alex Elderb82d1672013-01-14 12:43:31 -0600333 spinlock_t lock; /* queue, flags, open_count */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700334
335 struct rbd_image_header header;
Alex Elderb82d1672013-01-14 12:43:31 -0600336 unsigned long flags; /* possibly lock protected */
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500337 struct rbd_spec *spec;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700338
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500339 char *header_name;
Alex Elder971f8392012-10-25 23:34:41 -0500340
Alex Elder0903e872012-11-14 12:25:19 -0600341 struct ceph_file_layout layout;
342
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700343 struct ceph_osd_event *watch_event;
Alex Elder975241a2013-01-25 17:08:55 -0600344 struct rbd_obj_request *watch_request;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700345
Alex Elder86b00e02012-10-25 23:34:42 -0500346 struct rbd_spec *parent_spec;
347 u64 parent_overlap;
Alex Eldera2acd002013-05-08 22:50:04 -0500348 atomic_t parent_ref;
Alex Elder2f82ee52012-10-30 19:40:33 -0500349 struct rbd_device *parent;
Alex Elder86b00e02012-10-25 23:34:42 -0500350
Josh Durginc6666012011-11-21 17:11:12 -0800351 /* protects updating the header */
352 struct rw_semaphore header_rwsem;
Alex Elderf84344f2012-08-31 17:29:51 -0500353
354 struct rbd_mapping mapping;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700355
356 struct list_head node;
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800357
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800358 /* sysfs related */
359 struct device dev;
Alex Elderb82d1672013-01-14 12:43:31 -0600360 unsigned long open_count; /* protected by lock */
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800361};
362
Alex Elderb82d1672013-01-14 12:43:31 -0600363/*
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 */
Alex Elder6d292902013-01-14 12:43:31 -0600370enum rbd_dev_flags {
371 RBD_DEV_FLAG_EXISTS, /* mapped snapshot has not been deleted */
Alex Elderb82d1672013-01-14 12:43:31 -0600372 RBD_DEV_FLAG_REMOVING, /* this mapping is being removed */
Alex Elder6d292902013-01-14 12:43:31 -0600373};
374
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700375static DEFINE_MUTEX(ctl_mutex); /* Serialize open/close/setup/teardown */
Alex Eldere124a82f2012-01-29 13:57:44 -0600376
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700377static LIST_HEAD(rbd_dev_list); /* devices */
Alex Eldere124a82f2012-01-29 13:57:44 -0600378static DEFINE_SPINLOCK(rbd_dev_list_lock);
379
Alex Elder432b8582012-01-29 13:57:44 -0600380static LIST_HEAD(rbd_client_list); /* clients */
381static DEFINE_SPINLOCK(rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700382
Alex Elder78c2a442013-05-01 12:43:04 -0500383/* Slab caches for frequently-allocated structures */
384
Alex Elder1c2a9df2013-05-01 12:43:03 -0500385static struct kmem_cache *rbd_img_request_cache;
Alex Elder868311b2013-05-01 12:43:03 -0500386static struct kmem_cache *rbd_obj_request_cache;
Alex Elder78c2a442013-05-01 12:43:04 -0500387static struct kmem_cache *rbd_segment_name_cache;
Alex Elder1c2a9df2013-05-01 12:43:03 -0500388
Alex Elder3d7efd12013-04-19 15:34:50 -0500389static int rbd_img_request_submit(struct rbd_img_request *img_request);
390
Alex Elder200a6a82013-04-28 23:32:34 -0500391static void rbd_dev_device_release(struct device *dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800392
Alex Elderf0f8cef2012-01-29 13:57:44 -0600393static 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);
Alex Elder1f3ef782013-05-06 17:40:33 -0500397static int rbd_dev_image_probe(struct rbd_device *rbd_dev, bool mapping);
Alex Eldera2acd002013-05-08 22:50:04 -0500398static void rbd_spec_put(struct rbd_spec *spec);
Alex Elderf0f8cef2012-01-29 13:57:44 -0600399
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
Alex Elder06ecc6c2012-11-01 10:17:15 -0500420static __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
Alex Elderaafb2302012-09-06 16:00:54 -0500447#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 */
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800459
Alex Elderb454e362013-04-19 15:34:50 -0500460static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request);
Alex Elder05a46af2013-04-26 15:44:36 -0500461static void rbd_img_parent_read(struct rbd_obj_request *obj_request);
462static void rbd_dev_remove_parent(struct rbd_device *rbd_dev);
Alex Elder8b3e1a52013-01-24 16:13:36 -0600463
Alex Eldercc4a38bd2013-04-30 00:44:33 -0500464static int rbd_dev_refresh(struct rbd_device *rbd_dev);
Alex Elder2df3fac2013-05-06 09:51:30 -0500465static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev);
466static int rbd_dev_v2_header_info(struct rbd_device *rbd_dev);
Alex Elder54cac612013-04-30 00:44:33 -0500467static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
468 u64 snap_id);
Alex Elder2ad3d712013-04-30 00:44:33 -0500469static 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);
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700474
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700475static int rbd_open(struct block_device *bdev, fmode_t mode)
476{
Alex Elderf0f8cef2012-01-29 13:57:44 -0600477 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
Alex Elderb82d1672013-01-14 12:43:31 -0600478 bool removing = false;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700479
Alex Elderf84344f2012-08-31 17:29:51 -0500480 if ((mode & FMODE_WRITE) && rbd_dev->mapping.read_only)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700481 return -EROFS;
482
Alex Eldera14ea262013-02-05 13:23:12 -0600483 spin_lock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600484 if (test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags))
485 removing = true;
486 else
487 rbd_dev->open_count++;
Alex Eldera14ea262013-02-05 13:23:12 -0600488 spin_unlock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600489 if (removing)
490 return -ENOENT;
491
Alex Elder42382b72012-11-16 09:29:16 -0600492 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Alex Elderc3e946c2012-11-16 09:29:16 -0600493 (void) get_device(&rbd_dev->dev);
Alex Elderf84344f2012-08-31 17:29:51 -0500494 set_device_ro(bdev, rbd_dev->mapping.read_only);
Alex Elder42382b72012-11-16 09:29:16 -0600495 mutex_unlock(&ctl_mutex);
Alex Elder340c7a22012-08-10 13:12:07 -0700496
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700497 return 0;
498}
499
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800500static int rbd_release(struct gendisk *disk, fmode_t mode)
501{
502 struct rbd_device *rbd_dev = disk->private_data;
Alex Elderb82d1672013-01-14 12:43:31 -0600503 unsigned long open_count_before;
504
Alex Eldera14ea262013-02-05 13:23:12 -0600505 spin_lock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600506 open_count_before = rbd_dev->open_count--;
Alex Eldera14ea262013-02-05 13:23:12 -0600507 spin_unlock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600508 rbd_assert(open_count_before > 0);
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800509
Alex Elder42382b72012-11-16 09:29:16 -0600510 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Alex Elderc3e946c2012-11-16 09:29:16 -0600511 put_device(&rbd_dev->dev);
Alex Elder42382b72012-11-16 09:29:16 -0600512 mutex_unlock(&ctl_mutex);
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800513
514 return 0;
515}
516
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700517static const struct block_device_operations rbd_bd_ops = {
518 .owner = THIS_MODULE,
519 .open = rbd_open,
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800520 .release = rbd_release,
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700521};
522
523/*
Alex Elder7262cfc2013-05-16 15:04:20 -0500524 * Initialize an rbd client instance. Success or not, this function
525 * consumes ceph_opts.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700526 */
Alex Elderf8c38922012-08-10 13:12:07 -0700527static struct rbd_client *rbd_client_create(struct ceph_options *ceph_opts)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700528{
529 struct rbd_client *rbdc;
530 int ret = -ENOMEM;
531
Alex Elder37206ee2013-02-20 17:32:08 -0600532 dout("%s:\n", __func__);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700533 rbdc = kmalloc(sizeof(struct rbd_client), GFP_KERNEL);
534 if (!rbdc)
535 goto out_opt;
536
537 kref_init(&rbdc->kref);
538 INIT_LIST_HEAD(&rbdc->node);
539
Alex Elderbc534d82012-01-29 13:57:44 -0600540 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
541
Alex Elder43ae4702012-07-03 16:01:18 -0500542 rbdc->client = ceph_create_client(ceph_opts, rbdc, 0, 0);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700543 if (IS_ERR(rbdc->client))
Alex Elderbc534d82012-01-29 13:57:44 -0600544 goto out_mutex;
Alex Elder43ae4702012-07-03 16:01:18 -0500545 ceph_opts = NULL; /* Now rbdc->client is responsible for ceph_opts */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700546
547 ret = ceph_open_session(rbdc->client);
548 if (ret < 0)
549 goto out_err;
550
Alex Elder432b8582012-01-29 13:57:44 -0600551 spin_lock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700552 list_add_tail(&rbdc->node, &rbd_client_list);
Alex Elder432b8582012-01-29 13:57:44 -0600553 spin_unlock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700554
Alex Elderbc534d82012-01-29 13:57:44 -0600555 mutex_unlock(&ctl_mutex);
Alex Elder37206ee2013-02-20 17:32:08 -0600556 dout("%s: rbdc %p\n", __func__, rbdc);
Alex Elderbc534d82012-01-29 13:57:44 -0600557
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700558 return rbdc;
559
560out_err:
561 ceph_destroy_client(rbdc->client);
Alex Elderbc534d82012-01-29 13:57:44 -0600562out_mutex:
563 mutex_unlock(&ctl_mutex);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700564 kfree(rbdc);
565out_opt:
Alex Elder43ae4702012-07-03 16:01:18 -0500566 if (ceph_opts)
567 ceph_destroy_options(ceph_opts);
Alex Elder37206ee2013-02-20 17:32:08 -0600568 dout("%s: error %d\n", __func__, ret);
569
Vasiliy Kulikov28f259b2010-09-26 12:59:37 +0400570 return ERR_PTR(ret);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700571}
572
Alex Elder2f82ee52012-10-30 19:40:33 -0500573static struct rbd_client *__rbd_get_client(struct rbd_client *rbdc)
574{
575 kref_get(&rbdc->kref);
576
577 return rbdc;
578}
579
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700580/*
Alex Elder1f7ba332012-08-10 13:12:07 -0700581 * Find a ceph client with specific addr and configuration. If
582 * found, bump its reference count.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700583 */
Alex Elder1f7ba332012-08-10 13:12:07 -0700584static struct rbd_client *rbd_client_find(struct ceph_options *ceph_opts)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700585{
586 struct rbd_client *client_node;
Alex Elder1f7ba332012-08-10 13:12:07 -0700587 bool found = false;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700588
Alex Elder43ae4702012-07-03 16:01:18 -0500589 if (ceph_opts->flags & CEPH_OPT_NOSHARE)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700590 return NULL;
591
Alex Elder1f7ba332012-08-10 13:12:07 -0700592 spin_lock(&rbd_client_list_lock);
593 list_for_each_entry(client_node, &rbd_client_list, node) {
594 if (!ceph_compare_options(ceph_opts, client_node->client)) {
Alex Elder2f82ee52012-10-30 19:40:33 -0500595 __rbd_get_client(client_node);
596
Alex Elder1f7ba332012-08-10 13:12:07 -0700597 found = true;
598 break;
599 }
600 }
601 spin_unlock(&rbd_client_list_lock);
602
603 return found ? client_node : NULL;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700604}
605
606/*
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700607 * mount options
608 */
609enum {
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700610 Opt_last_int,
611 /* int args above */
612 Opt_last_string,
613 /* string args above */
Alex Eldercc0538b2012-08-10 13:12:07 -0700614 Opt_read_only,
615 Opt_read_write,
616 /* Boolean args above */
617 Opt_last_bool,
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700618};
619
Alex Elder43ae4702012-07-03 16:01:18 -0500620static match_table_t rbd_opts_tokens = {
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700621 /* int args above */
622 /* string args above */
Alex Elderbe466c12012-10-22 11:31:26 -0500623 {Opt_read_only, "read_only"},
Alex Eldercc0538b2012-08-10 13:12:07 -0700624 {Opt_read_only, "ro"}, /* Alternate spelling */
625 {Opt_read_write, "read_write"},
626 {Opt_read_write, "rw"}, /* Alternate spelling */
627 /* Boolean args above */
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700628 {-1, NULL}
629};
630
Alex Elder98571b52013-01-20 14:44:42 -0600631struct rbd_options {
632 bool read_only;
633};
634
635#define RBD_READ_ONLY_DEFAULT false
636
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700637static int parse_rbd_opts_token(char *c, void *private)
638{
Alex Elder43ae4702012-07-03 16:01:18 -0500639 struct rbd_options *rbd_opts = private;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700640 substring_t argstr[MAX_OPT_ARGS];
641 int token, intval, ret;
642
Alex Elder43ae4702012-07-03 16:01:18 -0500643 token = match_token(c, rbd_opts_tokens, argstr);
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700644 if (token < 0)
645 return -EINVAL;
646
647 if (token < Opt_last_int) {
648 ret = match_int(&argstr[0], &intval);
649 if (ret < 0) {
650 pr_err("bad mount option arg (not int) "
651 "at '%s'\n", c);
652 return ret;
653 }
654 dout("got int token %d val %d\n", token, intval);
655 } else if (token > Opt_last_int && token < Opt_last_string) {
656 dout("got string token %d val %s\n", token,
657 argstr[0].from);
Alex Eldercc0538b2012-08-10 13:12:07 -0700658 } else if (token > Opt_last_string && token < Opt_last_bool) {
659 dout("got Boolean token %d\n", token);
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700660 } else {
661 dout("got token %d\n", token);
662 }
663
664 switch (token) {
Alex Eldercc0538b2012-08-10 13:12:07 -0700665 case Opt_read_only:
666 rbd_opts->read_only = true;
667 break;
668 case Opt_read_write:
669 rbd_opts->read_only = false;
670 break;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700671 default:
Alex Elderaafb2302012-09-06 16:00:54 -0500672 rbd_assert(false);
673 break;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700674 }
675 return 0;
676}
677
678/*
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700679 * Get a ceph client with specific addr and configuration, if one does
Alex Elder7262cfc2013-05-16 15:04:20 -0500680 * not exist create it. Either way, ceph_opts is consumed by this
681 * function.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700682 */
Alex Elder9d3997f2012-10-25 23:34:42 -0500683static struct rbd_client *rbd_get_client(struct ceph_options *ceph_opts)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700684{
Alex Elderf8c38922012-08-10 13:12:07 -0700685 struct rbd_client *rbdc;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700686
Alex Elder1f7ba332012-08-10 13:12:07 -0700687 rbdc = rbd_client_find(ceph_opts);
Alex Elder9d3997f2012-10-25 23:34:42 -0500688 if (rbdc) /* using an existing client */
Alex Elder43ae4702012-07-03 16:01:18 -0500689 ceph_destroy_options(ceph_opts);
Alex Elder9d3997f2012-10-25 23:34:42 -0500690 else
Alex Elderf8c38922012-08-10 13:12:07 -0700691 rbdc = rbd_client_create(ceph_opts);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700692
Alex Elder9d3997f2012-10-25 23:34:42 -0500693 return rbdc;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700694}
695
696/*
697 * Destroy ceph client
Alex Elderd23a4b32012-01-29 13:57:43 -0600698 *
Alex Elder432b8582012-01-29 13:57:44 -0600699 * Caller must hold rbd_client_list_lock.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700700 */
701static void rbd_client_release(struct kref *kref)
702{
703 struct rbd_client *rbdc = container_of(kref, struct rbd_client, kref);
704
Alex Elder37206ee2013-02-20 17:32:08 -0600705 dout("%s: rbdc %p\n", __func__, rbdc);
Alex Eldercd9d9f52012-04-04 13:35:44 -0500706 spin_lock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700707 list_del(&rbdc->node);
Alex Eldercd9d9f52012-04-04 13:35:44 -0500708 spin_unlock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700709
710 ceph_destroy_client(rbdc->client);
711 kfree(rbdc);
712}
713
714/*
715 * Drop reference to ceph client node. If it's not referenced anymore, release
716 * it.
717 */
Alex Elder9d3997f2012-10-25 23:34:42 -0500718static void rbd_put_client(struct rbd_client *rbdc)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700719{
Alex Elderc53d5892012-10-25 23:34:42 -0500720 if (rbdc)
721 kref_put(&rbdc->kref, rbd_client_release);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700722}
723
Alex Eldera30b71b2012-07-10 20:30:11 -0500724static bool rbd_image_format_valid(u32 image_format)
725{
726 return image_format == 1 || image_format == 2;
727}
728
Alex Elder8e94af82012-07-25 09:32:40 -0500729static bool rbd_dev_ondisk_valid(struct rbd_image_header_ondisk *ondisk)
730{
Alex Elder103a1502012-08-02 11:29:45 -0500731 size_t size;
732 u32 snap_count;
733
734 /* The header has to start with the magic rbd header text */
735 if (memcmp(&ondisk->text, RBD_HEADER_TEXT, sizeof (RBD_HEADER_TEXT)))
736 return false;
737
Alex Elderdb2388b2012-10-20 22:17:27 -0500738 /* The bio layer requires at least sector-sized I/O */
739
740 if (ondisk->options.order < SECTOR_SHIFT)
741 return false;
742
743 /* If we use u64 in a few spots we may be able to loosen this */
744
745 if (ondisk->options.order > 8 * sizeof (int) - 1)
746 return false;
747
Alex Elder103a1502012-08-02 11:29:45 -0500748 /*
749 * The size of a snapshot header has to fit in a size_t, and
750 * that limits the number of snapshots.
751 */
752 snap_count = le32_to_cpu(ondisk->snap_count);
753 size = SIZE_MAX - sizeof (struct ceph_snap_context);
754 if (snap_count > size / sizeof (__le64))
755 return false;
756
757 /*
758 * Not only that, but the size of the entire the snapshot
759 * header must also be representable in a size_t.
760 */
761 size -= snap_count * sizeof (__le64);
762 if ((u64) size < le64_to_cpu(ondisk->snap_names_len))
763 return false;
764
765 return true;
Alex Elder8e94af82012-07-25 09:32:40 -0500766}
767
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700768/*
Alex Elderbb23e372013-05-06 09:51:29 -0500769 * Fill an rbd image header with information from the given format 1
770 * on-disk header.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700771 */
Alex Elder662518b2013-05-06 09:51:29 -0500772static int rbd_header_from_disk(struct rbd_device *rbd_dev,
Alex Elder4156d992012-08-02 11:29:46 -0500773 struct rbd_image_header_ondisk *ondisk)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700774{
Alex Elder662518b2013-05-06 09:51:29 -0500775 struct rbd_image_header *header = &rbd_dev->header;
Alex Elderbb23e372013-05-06 09:51:29 -0500776 bool first_time = header->object_prefix == NULL;
777 struct ceph_snap_context *snapc;
778 char *object_prefix = NULL;
779 char *snap_names = NULL;
780 u64 *snap_sizes = NULL;
Alex Elderccece232012-07-10 20:30:10 -0500781 u32 snap_count;
Alex Elderd2bb24e2012-07-26 23:37:14 -0500782 size_t size;
Alex Elderbb23e372013-05-06 09:51:29 -0500783 int ret = -ENOMEM;
Alex Elder621901d2012-08-23 23:22:06 -0500784 u32 i;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700785
Alex Elderbb23e372013-05-06 09:51:29 -0500786 /* Allocate this now to avoid having to handle failure below */
787
788 if (first_time) {
789 size_t len;
790
791 len = strnlen(ondisk->object_prefix,
792 sizeof (ondisk->object_prefix));
793 object_prefix = kmalloc(len + 1, GFP_KERNEL);
794 if (!object_prefix)
795 return -ENOMEM;
796 memcpy(object_prefix, ondisk->object_prefix, len);
797 object_prefix[len] = '\0';
798 }
799
800 /* Allocate the snapshot context and fill it in */
801
Alex Elder103a1502012-08-02 11:29:45 -0500802 snap_count = le32_to_cpu(ondisk->snap_count);
Alex Elderbb23e372013-05-06 09:51:29 -0500803 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
804 if (!snapc)
805 goto out_err;
806 snapc->seq = le64_to_cpu(ondisk->snap_seq);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700807 if (snap_count) {
Alex Elderbb23e372013-05-06 09:51:29 -0500808 struct rbd_image_snap_ondisk *snaps;
Alex Elderf785cc12012-08-23 23:22:06 -0500809 u64 snap_names_len = le64_to_cpu(ondisk->snap_names_len);
810
Alex Elderbb23e372013-05-06 09:51:29 -0500811 /* We'll keep a copy of the snapshot names... */
Alex Elder621901d2012-08-23 23:22:06 -0500812
Alex Elderbb23e372013-05-06 09:51:29 -0500813 if (snap_names_len > (u64)SIZE_MAX)
814 goto out_2big;
815 snap_names = kmalloc(snap_names_len, GFP_KERNEL);
816 if (!snap_names)
Alex Elder6a523252012-07-19 17:12:59 -0500817 goto out_err;
Alex Elderbb23e372013-05-06 09:51:29 -0500818
819 /* ...as well as the array of their sizes. */
820
821 size = snap_count * sizeof (*header->snap_sizes);
822 snap_sizes = kmalloc(size, GFP_KERNEL);
823 if (!snap_sizes)
824 goto out_err;
825
Alex Elderf785cc12012-08-23 23:22:06 -0500826 /*
Alex Elderbb23e372013-05-06 09:51:29 -0500827 * Copy the names, and fill in each snapshot's id
828 * and size.
829 *
Alex Elder99a41eb2013-05-06 09:51:30 -0500830 * Note that rbd_dev_v1_header_info() guarantees the
Alex Elderbb23e372013-05-06 09:51:29 -0500831 * ondisk buffer we're working with has
Alex Elderf785cc12012-08-23 23:22:06 -0500832 * snap_names_len bytes beyond the end of the
833 * snapshot id array, this memcpy() is safe.
834 */
Alex Elderbb23e372013-05-06 09:51:29 -0500835 memcpy(snap_names, &ondisk->snaps[snap_count], snap_names_len);
836 snaps = ondisk->snaps;
837 for (i = 0; i < snap_count; i++) {
838 snapc->snaps[i] = le64_to_cpu(snaps[i].id);
839 snap_sizes[i] = le64_to_cpu(snaps[i].image_size);
840 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700841 }
Alex Elder849b4262012-07-09 21:04:24 -0500842
Alex Elderbb23e372013-05-06 09:51:29 -0500843 /* We won't fail any more, fill in the header */
Alex Elder6a523252012-07-19 17:12:59 -0500844
Alex Elder662518b2013-05-06 09:51:29 -0500845 down_write(&rbd_dev->header_rwsem);
Alex Elderbb23e372013-05-06 09:51:29 -0500846 if (first_time) {
847 header->object_prefix = object_prefix;
848 header->obj_order = ondisk->options.order;
849 header->crypt_type = ondisk->options.crypt_type;
850 header->comp_type = ondisk->options.comp_type;
851 /* The rest aren't used for format 1 images */
852 header->stripe_unit = 0;
853 header->stripe_count = 0;
854 header->features = 0;
Alex Elder662518b2013-05-06 09:51:29 -0500855 } else {
856 ceph_put_snap_context(header->snapc);
857 kfree(header->snap_names);
858 kfree(header->snap_sizes);
Alex Elderbb23e372013-05-06 09:51:29 -0500859 }
860
861 /* The remaining fields always get updated (when we refresh) */
Alex Elder621901d2012-08-23 23:22:06 -0500862
Alex Elderf84344f2012-08-31 17:29:51 -0500863 header->image_size = le64_to_cpu(ondisk->image_size);
Alex Elderbb23e372013-05-06 09:51:29 -0500864 header->snapc = snapc;
865 header->snap_names = snap_names;
866 header->snap_sizes = snap_sizes;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700867
Alex Elder662518b2013-05-06 09:51:29 -0500868 /* Make sure mapping size is consistent with header info */
869
870 if (rbd_dev->spec->snap_id == CEPH_NOSNAP || first_time)
871 if (rbd_dev->mapping.size != header->image_size)
872 rbd_dev->mapping.size = header->image_size;
873
874 up_write(&rbd_dev->header_rwsem);
875
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700876 return 0;
Alex Elderbb23e372013-05-06 09:51:29 -0500877out_2big:
878 ret = -EIO;
Alex Elder6a523252012-07-19 17:12:59 -0500879out_err:
Alex Elderbb23e372013-05-06 09:51:29 -0500880 kfree(snap_sizes);
881 kfree(snap_names);
882 ceph_put_snap_context(snapc);
883 kfree(object_prefix);
Alex Elderccece232012-07-10 20:30:10 -0500884
Alex Elderbb23e372013-05-06 09:51:29 -0500885 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700886}
887
Alex Elder9682fc62013-04-30 00:44:33 -0500888static const char *_rbd_dev_v1_snap_name(struct rbd_device *rbd_dev, u32 which)
889{
890 const char *snap_name;
891
892 rbd_assert(which < rbd_dev->header.snapc->num_snaps);
893
894 /* Skip over names until we find the one we are looking for */
895
896 snap_name = rbd_dev->header.snap_names;
897 while (which--)
898 snap_name += strlen(snap_name) + 1;
899
900 return kstrdup(snap_name, GFP_KERNEL);
901}
902
Alex Elder30d1cff2013-05-01 12:43:03 -0500903/*
904 * Snapshot id comparison function for use with qsort()/bsearch().
905 * Note that result is for snapshots in *descending* order.
906 */
907static int snapid_compare_reverse(const void *s1, const void *s2)
908{
909 u64 snap_id1 = *(u64 *)s1;
910 u64 snap_id2 = *(u64 *)s2;
911
912 if (snap_id1 < snap_id2)
913 return 1;
914 return snap_id1 == snap_id2 ? 0 : -1;
915}
916
917/*
918 * Search a snapshot context to see if the given snapshot id is
919 * present.
920 *
921 * Returns the position of the snapshot id in the array if it's found,
922 * or BAD_SNAP_INDEX otherwise.
923 *
924 * Note: The snapshot array is in kept sorted (by the osd) in
925 * reverse order, highest snapshot id first.
926 */
Alex Elder9682fc62013-04-30 00:44:33 -0500927static u32 rbd_dev_snap_index(struct rbd_device *rbd_dev, u64 snap_id)
928{
929 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
Alex Elder30d1cff2013-05-01 12:43:03 -0500930 u64 *found;
Alex Elder9682fc62013-04-30 00:44:33 -0500931
Alex Elder30d1cff2013-05-01 12:43:03 -0500932 found = bsearch(&snap_id, &snapc->snaps, snapc->num_snaps,
933 sizeof (snap_id), snapid_compare_reverse);
Alex Elder9682fc62013-04-30 00:44:33 -0500934
Alex Elder30d1cff2013-05-01 12:43:03 -0500935 return found ? (u32)(found - &snapc->snaps[0]) : BAD_SNAP_INDEX;
Alex Elder9682fc62013-04-30 00:44:33 -0500936}
937
Alex Elder2ad3d712013-04-30 00:44:33 -0500938static const char *rbd_dev_v1_snap_name(struct rbd_device *rbd_dev,
939 u64 snap_id)
Alex Elder54cac612013-04-30 00:44:33 -0500940{
941 u32 which;
942
943 which = rbd_dev_snap_index(rbd_dev, snap_id);
944 if (which == BAD_SNAP_INDEX)
945 return NULL;
946
947 return _rbd_dev_v1_snap_name(rbd_dev, which);
948}
949
Alex Elder9e15b772012-10-30 19:40:33 -0500950static const char *rbd_snap_name(struct rbd_device *rbd_dev, u64 snap_id)
951{
Alex Elder9e15b772012-10-30 19:40:33 -0500952 if (snap_id == CEPH_NOSNAP)
953 return RBD_SNAP_HEAD_NAME;
954
Alex Elder54cac612013-04-30 00:44:33 -0500955 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
956 if (rbd_dev->image_format == 1)
957 return rbd_dev_v1_snap_name(rbd_dev, snap_id);
Alex Elder9e15b772012-10-30 19:40:33 -0500958
Alex Elder54cac612013-04-30 00:44:33 -0500959 return rbd_dev_v2_snap_name(rbd_dev, snap_id);
Alex Elder9e15b772012-10-30 19:40:33 -0500960}
961
Alex Elder2ad3d712013-04-30 00:44:33 -0500962static int rbd_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
963 u64 *snap_size)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700964{
Alex Elder2ad3d712013-04-30 00:44:33 -0500965 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
966 if (snap_id == CEPH_NOSNAP) {
967 *snap_size = rbd_dev->header.image_size;
968 } else if (rbd_dev->image_format == 1) {
969 u32 which;
Alex Elder00f1f362012-02-07 12:03:36 -0600970
Alex Elder2ad3d712013-04-30 00:44:33 -0500971 which = rbd_dev_snap_index(rbd_dev, snap_id);
972 if (which == BAD_SNAP_INDEX)
973 return -ENOENT;
Alex Elder00f1f362012-02-07 12:03:36 -0600974
Alex Elder2ad3d712013-04-30 00:44:33 -0500975 *snap_size = rbd_dev->header.snap_sizes[which];
976 } else {
977 u64 size = 0;
978 int ret;
979
980 ret = _rbd_dev_v2_snap_size(rbd_dev, snap_id, NULL, &size);
981 if (ret)
982 return ret;
983
984 *snap_size = size;
985 }
986 return 0;
987}
988
989static int rbd_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
990 u64 *snap_features)
991{
992 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
993 if (snap_id == CEPH_NOSNAP) {
994 *snap_features = rbd_dev->header.features;
995 } else if (rbd_dev->image_format == 1) {
996 *snap_features = 0; /* No features for format 1 */
997 } else {
998 u64 features = 0;
999 int ret;
1000
1001 ret = _rbd_dev_v2_snap_features(rbd_dev, snap_id, &features);
1002 if (ret)
1003 return ret;
1004
1005 *snap_features = features;
1006 }
1007 return 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001008}
1009
Alex Elderd1cf5782013-04-27 09:59:30 -05001010static int rbd_dev_mapping_set(struct rbd_device *rbd_dev)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001011{
Alex Elder8f4b7d92013-05-06 07:40:30 -05001012 u64 snap_id = rbd_dev->spec->snap_id;
Alex Elder2ad3d712013-04-30 00:44:33 -05001013 u64 size = 0;
1014 u64 features = 0;
1015 int ret;
Alex Elder8b0241f2013-04-25 23:15:08 -05001016
Alex Elder2ad3d712013-04-30 00:44:33 -05001017 ret = rbd_snap_size(rbd_dev, snap_id, &size);
1018 if (ret)
1019 return ret;
1020 ret = rbd_snap_features(rbd_dev, snap_id, &features);
1021 if (ret)
1022 return ret;
1023
1024 rbd_dev->mapping.size = size;
1025 rbd_dev->mapping.features = features;
1026
Alex Elder8b0241f2013-04-25 23:15:08 -05001027 return 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001028}
1029
Alex Elderd1cf5782013-04-27 09:59:30 -05001030static void rbd_dev_mapping_clear(struct rbd_device *rbd_dev)
1031{
1032 rbd_dev->mapping.size = 0;
1033 rbd_dev->mapping.features = 0;
Alex Elderd1cf5782013-04-27 09:59:30 -05001034}
1035
Alex Elder98571b52013-01-20 14:44:42 -06001036static const char *rbd_segment_name(struct rbd_device *rbd_dev, u64 offset)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001037{
Alex Elder65ccfe22012-08-09 10:33:26 -07001038 char *name;
1039 u64 segment;
1040 int ret;
Josh Durgin3a96d5c2013-06-12 19:15:06 -07001041 char *name_format;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001042
Alex Elder78c2a442013-05-01 12:43:04 -05001043 name = kmem_cache_alloc(rbd_segment_name_cache, GFP_NOIO);
Alex Elder65ccfe22012-08-09 10:33:26 -07001044 if (!name)
1045 return NULL;
1046 segment = offset >> rbd_dev->header.obj_order;
Josh Durgin3a96d5c2013-06-12 19:15:06 -07001047 name_format = "%s.%012llx";
1048 if (rbd_dev->image_format == 2)
1049 name_format = "%s.%016llx";
1050 ret = snprintf(name, MAX_OBJ_NAME_SIZE + 1, name_format,
Alex Elder65ccfe22012-08-09 10:33:26 -07001051 rbd_dev->header.object_prefix, segment);
Alex Elder2fd82b92012-11-09 15:05:54 -06001052 if (ret < 0 || ret > MAX_OBJ_NAME_SIZE) {
Alex Elder65ccfe22012-08-09 10:33:26 -07001053 pr_err("error formatting segment name for #%llu (%d)\n",
1054 segment, ret);
1055 kfree(name);
1056 name = NULL;
1057 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001058
Alex Elder65ccfe22012-08-09 10:33:26 -07001059 return name;
1060}
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001061
Alex Elder78c2a442013-05-01 12:43:04 -05001062static void rbd_segment_name_free(const char *name)
1063{
1064 /* The explicit cast here is needed to drop the const qualifier */
1065
1066 kmem_cache_free(rbd_segment_name_cache, (void *)name);
1067}
1068
Alex Elder65ccfe22012-08-09 10:33:26 -07001069static u64 rbd_segment_offset(struct rbd_device *rbd_dev, u64 offset)
1070{
1071 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001072
Alex Elder65ccfe22012-08-09 10:33:26 -07001073 return offset & (segment_size - 1);
1074}
1075
1076static u64 rbd_segment_length(struct rbd_device *rbd_dev,
1077 u64 offset, u64 length)
1078{
1079 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
1080
1081 offset &= segment_size - 1;
1082
Alex Elderaafb2302012-09-06 16:00:54 -05001083 rbd_assert(length <= U64_MAX - offset);
Alex Elder65ccfe22012-08-09 10:33:26 -07001084 if (offset + length > segment_size)
1085 length = segment_size - offset;
1086
1087 return length;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001088}
1089
1090/*
Josh Durgin029bcbd2011-07-22 11:35:23 -07001091 * returns the size of an object in the image
1092 */
1093static u64 rbd_obj_bytes(struct rbd_image_header *header)
1094{
1095 return 1 << header->obj_order;
1096}
1097
1098/*
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001099 * bio helpers
1100 */
1101
1102static void bio_chain_put(struct bio *chain)
1103{
1104 struct bio *tmp;
1105
1106 while (chain) {
1107 tmp = chain;
1108 chain = chain->bi_next;
1109 bio_put(tmp);
1110 }
1111}
1112
1113/*
1114 * zeros a bio chain, starting at specific offset
1115 */
1116static void zero_bio_chain(struct bio *chain, int start_ofs)
1117{
1118 struct bio_vec *bv;
1119 unsigned long flags;
1120 void *buf;
1121 int i;
1122 int pos = 0;
1123
1124 while (chain) {
1125 bio_for_each_segment(bv, chain, i) {
1126 if (pos + bv->bv_len > start_ofs) {
1127 int remainder = max(start_ofs - pos, 0);
1128 buf = bvec_kmap_irq(bv, &flags);
1129 memset(buf + remainder, 0,
1130 bv->bv_len - remainder);
Dan Carpenter85b5aaa2010-10-11 21:15:11 +02001131 bvec_kunmap_irq(buf, &flags);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001132 }
1133 pos += bv->bv_len;
1134 }
1135
1136 chain = chain->bi_next;
1137 }
1138}
1139
1140/*
Alex Elderb9434c52013-04-19 15:34:50 -05001141 * similar to zero_bio_chain(), zeros data defined by a page array,
1142 * starting at the given byte offset from the start of the array and
1143 * continuing up to the given end offset. The pages array is
1144 * assumed to be big enough to hold all bytes up to the end.
1145 */
1146static void zero_pages(struct page **pages, u64 offset, u64 end)
1147{
1148 struct page **page = &pages[offset >> PAGE_SHIFT];
1149
1150 rbd_assert(end > offset);
1151 rbd_assert(end - offset <= (u64)SIZE_MAX);
1152 while (offset < end) {
1153 size_t page_offset;
1154 size_t length;
1155 unsigned long flags;
1156 void *kaddr;
1157
1158 page_offset = (size_t)(offset & ~PAGE_MASK);
1159 length = min(PAGE_SIZE - page_offset, (size_t)(end - offset));
1160 local_irq_save(flags);
1161 kaddr = kmap_atomic(*page);
1162 memset(kaddr + page_offset, 0, length);
1163 kunmap_atomic(kaddr);
1164 local_irq_restore(flags);
1165
1166 offset += length;
1167 page++;
1168 }
1169}
1170
1171/*
Alex Elderf7760da2012-10-20 22:17:27 -05001172 * Clone a portion of a bio, starting at the given byte offset
1173 * and continuing for the number of bytes indicated.
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001174 */
Alex Elderf7760da2012-10-20 22:17:27 -05001175static struct bio *bio_clone_range(struct bio *bio_src,
1176 unsigned int offset,
1177 unsigned int len,
1178 gfp_t gfpmask)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001179{
Alex Elderf7760da2012-10-20 22:17:27 -05001180 struct bio_vec *bv;
1181 unsigned int resid;
1182 unsigned short idx;
1183 unsigned int voff;
1184 unsigned short end_idx;
1185 unsigned short vcnt;
1186 struct bio *bio;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001187
Alex Elderf7760da2012-10-20 22:17:27 -05001188 /* Handle the easy case for the caller */
1189
1190 if (!offset && len == bio_src->bi_size)
1191 return bio_clone(bio_src, gfpmask);
1192
1193 if (WARN_ON_ONCE(!len))
1194 return NULL;
1195 if (WARN_ON_ONCE(len > bio_src->bi_size))
1196 return NULL;
1197 if (WARN_ON_ONCE(offset > bio_src->bi_size - len))
1198 return NULL;
1199
1200 /* Find first affected segment... */
1201
1202 resid = offset;
1203 __bio_for_each_segment(bv, bio_src, idx, 0) {
1204 if (resid < bv->bv_len)
1205 break;
1206 resid -= bv->bv_len;
1207 }
1208 voff = resid;
1209
1210 /* ...and the last affected segment */
1211
1212 resid += len;
1213 __bio_for_each_segment(bv, bio_src, end_idx, idx) {
1214 if (resid <= bv->bv_len)
1215 break;
1216 resid -= bv->bv_len;
1217 }
1218 vcnt = end_idx - idx + 1;
1219
1220 /* Build the clone */
1221
1222 bio = bio_alloc(gfpmask, (unsigned int) vcnt);
1223 if (!bio)
1224 return NULL; /* ENOMEM */
1225
1226 bio->bi_bdev = bio_src->bi_bdev;
1227 bio->bi_sector = bio_src->bi_sector + (offset >> SECTOR_SHIFT);
1228 bio->bi_rw = bio_src->bi_rw;
1229 bio->bi_flags |= 1 << BIO_CLONED;
1230
1231 /*
1232 * Copy over our part of the bio_vec, then update the first
1233 * and last (or only) entries.
1234 */
1235 memcpy(&bio->bi_io_vec[0], &bio_src->bi_io_vec[idx],
1236 vcnt * sizeof (struct bio_vec));
1237 bio->bi_io_vec[0].bv_offset += voff;
1238 if (vcnt > 1) {
1239 bio->bi_io_vec[0].bv_len -= voff;
1240 bio->bi_io_vec[vcnt - 1].bv_len = resid;
1241 } else {
1242 bio->bi_io_vec[0].bv_len = len;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001243 }
1244
Alex Elderf7760da2012-10-20 22:17:27 -05001245 bio->bi_vcnt = vcnt;
1246 bio->bi_size = len;
1247 bio->bi_idx = 0;
Alex Elder542582f2012-08-09 10:33:25 -07001248
Alex Elderf7760da2012-10-20 22:17:27 -05001249 return bio;
1250}
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001251
Alex Elderf7760da2012-10-20 22:17:27 -05001252/*
1253 * Clone a portion of a bio chain, starting at the given byte offset
1254 * into the first bio in the source chain and continuing for the
1255 * number of bytes indicated. The result is another bio chain of
1256 * exactly the given length, or a null pointer on error.
1257 *
1258 * The bio_src and offset parameters are both in-out. On entry they
1259 * refer to the first source bio and the offset into that bio where
1260 * the start of data to be cloned is located.
1261 *
1262 * On return, bio_src is updated to refer to the bio in the source
1263 * chain that contains first un-cloned byte, and *offset will
1264 * contain the offset of that byte within that bio.
1265 */
1266static struct bio *bio_chain_clone_range(struct bio **bio_src,
1267 unsigned int *offset,
1268 unsigned int len,
1269 gfp_t gfpmask)
1270{
1271 struct bio *bi = *bio_src;
1272 unsigned int off = *offset;
1273 struct bio *chain = NULL;
1274 struct bio **end;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001275
Alex Elderf7760da2012-10-20 22:17:27 -05001276 /* Build up a chain of clone bios up to the limit */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001277
Alex Elderf7760da2012-10-20 22:17:27 -05001278 if (!bi || off >= bi->bi_size || !len)
1279 return NULL; /* Nothing to clone */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001280
Alex Elderf7760da2012-10-20 22:17:27 -05001281 end = &chain;
1282 while (len) {
1283 unsigned int bi_size;
1284 struct bio *bio;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001285
Alex Elderf5400b72012-11-01 10:17:15 -05001286 if (!bi) {
1287 rbd_warn(NULL, "bio_chain exhausted with %u left", len);
Alex Elderf7760da2012-10-20 22:17:27 -05001288 goto out_err; /* EINVAL; ran out of bio's */
Alex Elderf5400b72012-11-01 10:17:15 -05001289 }
Alex Elderf7760da2012-10-20 22:17:27 -05001290 bi_size = min_t(unsigned int, bi->bi_size - off, len);
1291 bio = bio_clone_range(bi, off, bi_size, gfpmask);
1292 if (!bio)
1293 goto out_err; /* ENOMEM */
1294
1295 *end = bio;
1296 end = &bio->bi_next;
1297
1298 off += bi_size;
1299 if (off == bi->bi_size) {
1300 bi = bi->bi_next;
1301 off = 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001302 }
Alex Elderf7760da2012-10-20 22:17:27 -05001303 len -= bi_size;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001304 }
Alex Elderf7760da2012-10-20 22:17:27 -05001305 *bio_src = bi;
1306 *offset = off;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001307
Alex Elderf7760da2012-10-20 22:17:27 -05001308 return chain;
1309out_err:
1310 bio_chain_put(chain);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001311
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001312 return NULL;
1313}
1314
Alex Elder926f9b32013-02-11 12:33:24 -06001315/*
1316 * The default/initial value for all object request flags is 0. For
1317 * each flag, once its value is set to 1 it is never reset to 0
1318 * again.
1319 */
Alex Elder6365d332013-02-11 12:33:24 -06001320static void obj_request_img_data_set(struct rbd_obj_request *obj_request)
1321{
1322 if (test_and_set_bit(OBJ_REQ_IMG_DATA, &obj_request->flags)) {
Alex Elder6365d332013-02-11 12:33:24 -06001323 struct rbd_device *rbd_dev;
1324
Alex Elder57acbaa2013-02-11 12:33:24 -06001325 rbd_dev = obj_request->img_request->rbd_dev;
Alex Elder6365d332013-02-11 12:33:24 -06001326 rbd_warn(rbd_dev, "obj_request %p already marked img_data\n",
1327 obj_request);
1328 }
1329}
1330
1331static bool obj_request_img_data_test(struct rbd_obj_request *obj_request)
1332{
1333 smp_mb();
1334 return test_bit(OBJ_REQ_IMG_DATA, &obj_request->flags) != 0;
1335}
1336
Alex Elder57acbaa2013-02-11 12:33:24 -06001337static void obj_request_done_set(struct rbd_obj_request *obj_request)
1338{
1339 if (test_and_set_bit(OBJ_REQ_DONE, &obj_request->flags)) {
1340 struct rbd_device *rbd_dev = NULL;
1341
1342 if (obj_request_img_data_test(obj_request))
1343 rbd_dev = obj_request->img_request->rbd_dev;
1344 rbd_warn(rbd_dev, "obj_request %p already marked done\n",
1345 obj_request);
1346 }
1347}
1348
1349static bool obj_request_done_test(struct rbd_obj_request *obj_request)
1350{
1351 smp_mb();
1352 return test_bit(OBJ_REQ_DONE, &obj_request->flags) != 0;
1353}
1354
Alex Elder5679c592013-02-11 12:33:24 -06001355/*
1356 * This sets the KNOWN flag after (possibly) setting the EXISTS
1357 * flag. The latter is set based on the "exists" value provided.
1358 *
1359 * Note that for our purposes once an object exists it never goes
1360 * away again. It's possible that the response from two existence
1361 * checks are separated by the creation of the target object, and
1362 * the first ("doesn't exist") response arrives *after* the second
1363 * ("does exist"). In that case we ignore the second one.
1364 */
1365static void obj_request_existence_set(struct rbd_obj_request *obj_request,
1366 bool exists)
1367{
1368 if (exists)
1369 set_bit(OBJ_REQ_EXISTS, &obj_request->flags);
1370 set_bit(OBJ_REQ_KNOWN, &obj_request->flags);
1371 smp_mb();
1372}
1373
1374static bool obj_request_known_test(struct rbd_obj_request *obj_request)
1375{
1376 smp_mb();
1377 return test_bit(OBJ_REQ_KNOWN, &obj_request->flags) != 0;
1378}
1379
1380static bool obj_request_exists_test(struct rbd_obj_request *obj_request)
1381{
1382 smp_mb();
1383 return test_bit(OBJ_REQ_EXISTS, &obj_request->flags) != 0;
1384}
1385
Alex Elderbf0d5f502012-11-22 00:00:08 -06001386static void rbd_obj_request_get(struct rbd_obj_request *obj_request)
1387{
Alex Elder37206ee2013-02-20 17:32:08 -06001388 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1389 atomic_read(&obj_request->kref.refcount));
Alex Elderbf0d5f502012-11-22 00:00:08 -06001390 kref_get(&obj_request->kref);
1391}
1392
1393static void rbd_obj_request_destroy(struct kref *kref);
1394static void rbd_obj_request_put(struct rbd_obj_request *obj_request)
1395{
1396 rbd_assert(obj_request != NULL);
Alex Elder37206ee2013-02-20 17:32:08 -06001397 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1398 atomic_read(&obj_request->kref.refcount));
Alex Elderbf0d5f502012-11-22 00:00:08 -06001399 kref_put(&obj_request->kref, rbd_obj_request_destroy);
1400}
1401
Alex Eldere93f3152013-05-08 22:50:04 -05001402static bool img_request_child_test(struct rbd_img_request *img_request);
1403static void rbd_parent_request_destroy(struct kref *kref);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001404static void rbd_img_request_destroy(struct kref *kref);
1405static void rbd_img_request_put(struct rbd_img_request *img_request)
1406{
1407 rbd_assert(img_request != NULL);
Alex Elder37206ee2013-02-20 17:32:08 -06001408 dout("%s: img %p (was %d)\n", __func__, img_request,
1409 atomic_read(&img_request->kref.refcount));
Alex Eldere93f3152013-05-08 22:50:04 -05001410 if (img_request_child_test(img_request))
1411 kref_put(&img_request->kref, rbd_parent_request_destroy);
1412 else
1413 kref_put(&img_request->kref, rbd_img_request_destroy);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001414}
1415
1416static inline void rbd_img_obj_request_add(struct rbd_img_request *img_request,
1417 struct rbd_obj_request *obj_request)
1418{
Alex Elder25dcf952013-01-25 17:08:55 -06001419 rbd_assert(obj_request->img_request == NULL);
1420
Alex Elderb155e862013-04-15 14:50:37 -05001421 /* Image request now owns object's original reference */
Alex Elderbf0d5f502012-11-22 00:00:08 -06001422 obj_request->img_request = img_request;
Alex Elder25dcf952013-01-25 17:08:55 -06001423 obj_request->which = img_request->obj_request_count;
Alex Elder6365d332013-02-11 12:33:24 -06001424 rbd_assert(!obj_request_img_data_test(obj_request));
1425 obj_request_img_data_set(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001426 rbd_assert(obj_request->which != BAD_WHICH);
Alex Elder25dcf952013-01-25 17:08:55 -06001427 img_request->obj_request_count++;
1428 list_add_tail(&obj_request->links, &img_request->obj_requests);
Alex Elder37206ee2013-02-20 17:32:08 -06001429 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1430 obj_request->which);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001431}
1432
1433static inline void rbd_img_obj_request_del(struct rbd_img_request *img_request,
1434 struct rbd_obj_request *obj_request)
1435{
1436 rbd_assert(obj_request->which != BAD_WHICH);
Alex Elder25dcf952013-01-25 17:08:55 -06001437
Alex Elder37206ee2013-02-20 17:32:08 -06001438 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1439 obj_request->which);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001440 list_del(&obj_request->links);
Alex Elder25dcf952013-01-25 17:08:55 -06001441 rbd_assert(img_request->obj_request_count > 0);
1442 img_request->obj_request_count--;
1443 rbd_assert(obj_request->which == img_request->obj_request_count);
1444 obj_request->which = BAD_WHICH;
Alex Elder6365d332013-02-11 12:33:24 -06001445 rbd_assert(obj_request_img_data_test(obj_request));
Alex Elderbf0d5f502012-11-22 00:00:08 -06001446 rbd_assert(obj_request->img_request == img_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001447 obj_request->img_request = NULL;
Alex Elder25dcf952013-01-25 17:08:55 -06001448 obj_request->callback = NULL;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001449 rbd_obj_request_put(obj_request);
1450}
1451
1452static bool obj_request_type_valid(enum obj_request_type type)
1453{
1454 switch (type) {
Alex Elder9969ebc2013-01-18 12:31:10 -06001455 case OBJ_REQUEST_NODATA:
Alex Elderbf0d5f502012-11-22 00:00:08 -06001456 case OBJ_REQUEST_BIO:
Alex Elder788e2df2013-01-17 12:25:27 -06001457 case OBJ_REQUEST_PAGES:
Alex Elderbf0d5f502012-11-22 00:00:08 -06001458 return true;
1459 default:
1460 return false;
1461 }
1462}
1463
Alex Elderbf0d5f502012-11-22 00:00:08 -06001464static int rbd_obj_request_submit(struct ceph_osd_client *osdc,
1465 struct rbd_obj_request *obj_request)
1466{
Alex Elder37206ee2013-02-20 17:32:08 -06001467 dout("%s: osdc %p obj %p\n", __func__, osdc, obj_request);
1468
Alex Elderbf0d5f502012-11-22 00:00:08 -06001469 return ceph_osdc_start_request(osdc, obj_request->osd_req, false);
1470}
1471
1472static void rbd_img_request_complete(struct rbd_img_request *img_request)
1473{
Alex Elder55f27e02013-04-10 12:34:25 -05001474
Alex Elder37206ee2013-02-20 17:32:08 -06001475 dout("%s: img %p\n", __func__, img_request);
Alex Elder55f27e02013-04-10 12:34:25 -05001476
1477 /*
1478 * If no error occurred, compute the aggregate transfer
1479 * count for the image request. We could instead use
1480 * atomic64_cmpxchg() to update it as each object request
1481 * completes; not clear which way is better off hand.
1482 */
1483 if (!img_request->result) {
1484 struct rbd_obj_request *obj_request;
1485 u64 xferred = 0;
1486
1487 for_each_obj_request(img_request, obj_request)
1488 xferred += obj_request->xferred;
1489 img_request->xferred = xferred;
1490 }
1491
Alex Elderbf0d5f502012-11-22 00:00:08 -06001492 if (img_request->callback)
1493 img_request->callback(img_request);
1494 else
1495 rbd_img_request_put(img_request);
1496}
1497
Alex Elder788e2df2013-01-17 12:25:27 -06001498/* Caller is responsible for rbd_obj_request_destroy(obj_request) */
1499
1500static int rbd_obj_request_wait(struct rbd_obj_request *obj_request)
1501{
Alex Elder37206ee2013-02-20 17:32:08 -06001502 dout("%s: obj %p\n", __func__, obj_request);
1503
Alex Elder788e2df2013-01-17 12:25:27 -06001504 return wait_for_completion_interruptible(&obj_request->completion);
1505}
1506
Alex Elder0c425242013-02-08 09:55:49 -06001507/*
1508 * The default/initial value for all image request flags is 0. Each
1509 * is conditionally set to 1 at image request initialization time
1510 * and currently never change thereafter.
1511 */
1512static void img_request_write_set(struct rbd_img_request *img_request)
1513{
1514 set_bit(IMG_REQ_WRITE, &img_request->flags);
1515 smp_mb();
1516}
1517
1518static bool img_request_write_test(struct rbd_img_request *img_request)
1519{
1520 smp_mb();
1521 return test_bit(IMG_REQ_WRITE, &img_request->flags) != 0;
1522}
1523
Alex Elder9849e982013-01-24 16:13:36 -06001524static void img_request_child_set(struct rbd_img_request *img_request)
1525{
1526 set_bit(IMG_REQ_CHILD, &img_request->flags);
1527 smp_mb();
1528}
1529
Alex Eldere93f3152013-05-08 22:50:04 -05001530static void img_request_child_clear(struct rbd_img_request *img_request)
1531{
1532 clear_bit(IMG_REQ_CHILD, &img_request->flags);
1533 smp_mb();
1534}
1535
Alex Elder9849e982013-01-24 16:13:36 -06001536static bool img_request_child_test(struct rbd_img_request *img_request)
1537{
1538 smp_mb();
1539 return test_bit(IMG_REQ_CHILD, &img_request->flags) != 0;
1540}
1541
Alex Elderd0b2e942013-01-24 16:13:36 -06001542static void img_request_layered_set(struct rbd_img_request *img_request)
1543{
1544 set_bit(IMG_REQ_LAYERED, &img_request->flags);
1545 smp_mb();
1546}
1547
Alex Eldera2acd002013-05-08 22:50:04 -05001548static void img_request_layered_clear(struct rbd_img_request *img_request)
1549{
1550 clear_bit(IMG_REQ_LAYERED, &img_request->flags);
1551 smp_mb();
1552}
1553
Alex Elderd0b2e942013-01-24 16:13:36 -06001554static bool img_request_layered_test(struct rbd_img_request *img_request)
1555{
1556 smp_mb();
1557 return test_bit(IMG_REQ_LAYERED, &img_request->flags) != 0;
1558}
1559
Alex Elder6e2a4502013-03-27 09:16:30 -05001560static void
1561rbd_img_obj_request_read_callback(struct rbd_obj_request *obj_request)
1562{
Alex Elderb9434c52013-04-19 15:34:50 -05001563 u64 xferred = obj_request->xferred;
1564 u64 length = obj_request->length;
1565
Alex Elder6e2a4502013-03-27 09:16:30 -05001566 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1567 obj_request, obj_request->img_request, obj_request->result,
Alex Elderb9434c52013-04-19 15:34:50 -05001568 xferred, length);
Alex Elder6e2a4502013-03-27 09:16:30 -05001569 /*
1570 * ENOENT means a hole in the image. We zero-fill the
1571 * entire length of the request. A short read also implies
1572 * zero-fill to the end of the request. Either way we
1573 * update the xferred count to indicate the whole request
1574 * was satisfied.
1575 */
Alex Elderb9434c52013-04-19 15:34:50 -05001576 rbd_assert(obj_request->type != OBJ_REQUEST_NODATA);
Alex Elder6e2a4502013-03-27 09:16:30 -05001577 if (obj_request->result == -ENOENT) {
Alex Elderb9434c52013-04-19 15:34:50 -05001578 if (obj_request->type == OBJ_REQUEST_BIO)
1579 zero_bio_chain(obj_request->bio_list, 0);
1580 else
1581 zero_pages(obj_request->pages, 0, length);
Alex Elder6e2a4502013-03-27 09:16:30 -05001582 obj_request->result = 0;
Alex Elderb9434c52013-04-19 15:34:50 -05001583 obj_request->xferred = length;
1584 } else if (xferred < length && !obj_request->result) {
1585 if (obj_request->type == OBJ_REQUEST_BIO)
1586 zero_bio_chain(obj_request->bio_list, xferred);
1587 else
1588 zero_pages(obj_request->pages, xferred, length);
1589 obj_request->xferred = length;
Alex Elder6e2a4502013-03-27 09:16:30 -05001590 }
1591 obj_request_done_set(obj_request);
1592}
1593
Alex Elderbf0d5f502012-11-22 00:00:08 -06001594static void rbd_obj_request_complete(struct rbd_obj_request *obj_request)
1595{
Alex Elder37206ee2013-02-20 17:32:08 -06001596 dout("%s: obj %p cb %p\n", __func__, obj_request,
1597 obj_request->callback);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001598 if (obj_request->callback)
1599 obj_request->callback(obj_request);
Alex Elder788e2df2013-01-17 12:25:27 -06001600 else
1601 complete_all(&obj_request->completion);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001602}
1603
Alex Elderc47f9372013-02-26 14:23:07 -06001604static void rbd_osd_trivial_callback(struct rbd_obj_request *obj_request)
Alex Elder39bf2c52013-02-26 14:23:07 -06001605{
1606 dout("%s: obj %p\n", __func__, obj_request);
1607 obj_request_done_set(obj_request);
1608}
1609
Alex Elderc47f9372013-02-26 14:23:07 -06001610static void rbd_osd_read_callback(struct rbd_obj_request *obj_request)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001611{
Alex Elder57acbaa2013-02-11 12:33:24 -06001612 struct rbd_img_request *img_request = NULL;
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05001613 struct rbd_device *rbd_dev = NULL;
Alex Elder57acbaa2013-02-11 12:33:24 -06001614 bool layered = false;
1615
1616 if (obj_request_img_data_test(obj_request)) {
1617 img_request = obj_request->img_request;
1618 layered = img_request && img_request_layered_test(img_request);
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05001619 rbd_dev = img_request->rbd_dev;
Alex Elder57acbaa2013-02-11 12:33:24 -06001620 }
Alex Elder8b3e1a52013-01-24 16:13:36 -06001621
1622 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1623 obj_request, img_request, obj_request->result,
1624 obj_request->xferred, obj_request->length);
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05001625 if (layered && obj_request->result == -ENOENT &&
1626 obj_request->img_offset < rbd_dev->parent_overlap)
Alex Elder8b3e1a52013-01-24 16:13:36 -06001627 rbd_img_parent_read(obj_request);
1628 else if (img_request)
Alex Elder6e2a4502013-03-27 09:16:30 -05001629 rbd_img_obj_request_read_callback(obj_request);
1630 else
1631 obj_request_done_set(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001632}
1633
Alex Elderc47f9372013-02-26 14:23:07 -06001634static void rbd_osd_write_callback(struct rbd_obj_request *obj_request)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001635{
Sage Weil1b83bef2013-02-25 16:11:12 -08001636 dout("%s: obj %p result %d %llu\n", __func__, obj_request,
1637 obj_request->result, obj_request->length);
1638 /*
Alex Elder8b3e1a52013-01-24 16:13:36 -06001639 * There is no such thing as a successful short write. Set
1640 * it to our originally-requested length.
Sage Weil1b83bef2013-02-25 16:11:12 -08001641 */
1642 obj_request->xferred = obj_request->length;
Alex Elder07741302013-02-05 23:41:50 -06001643 obj_request_done_set(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001644}
1645
Alex Elderfbfab532013-02-08 09:55:48 -06001646/*
1647 * For a simple stat call there's nothing to do. We'll do more if
1648 * this is part of a write sequence for a layered image.
1649 */
Alex Elderc47f9372013-02-26 14:23:07 -06001650static void rbd_osd_stat_callback(struct rbd_obj_request *obj_request)
Alex Elderfbfab532013-02-08 09:55:48 -06001651{
Alex Elder37206ee2013-02-20 17:32:08 -06001652 dout("%s: obj %p\n", __func__, obj_request);
Alex Elderfbfab532013-02-08 09:55:48 -06001653 obj_request_done_set(obj_request);
1654}
1655
Alex Elderbf0d5f502012-11-22 00:00:08 -06001656static void rbd_osd_req_callback(struct ceph_osd_request *osd_req,
1657 struct ceph_msg *msg)
1658{
1659 struct rbd_obj_request *obj_request = osd_req->r_priv;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001660 u16 opcode;
1661
Alex Elder37206ee2013-02-20 17:32:08 -06001662 dout("%s: osd_req %p msg %p\n", __func__, osd_req, msg);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001663 rbd_assert(osd_req == obj_request->osd_req);
Alex Elder57acbaa2013-02-11 12:33:24 -06001664 if (obj_request_img_data_test(obj_request)) {
1665 rbd_assert(obj_request->img_request);
1666 rbd_assert(obj_request->which != BAD_WHICH);
1667 } else {
1668 rbd_assert(obj_request->which == BAD_WHICH);
1669 }
Alex Elderbf0d5f502012-11-22 00:00:08 -06001670
Sage Weil1b83bef2013-02-25 16:11:12 -08001671 if (osd_req->r_result < 0)
1672 obj_request->result = osd_req->r_result;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001673
Alex Elder0eefd472013-04-19 15:34:50 -05001674 BUG_ON(osd_req->r_num_ops > 2);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001675
Alex Elderc47f9372013-02-26 14:23:07 -06001676 /*
1677 * We support a 64-bit length, but ultimately it has to be
1678 * passed to blk_end_request(), which takes an unsigned int.
1679 */
Sage Weil1b83bef2013-02-25 16:11:12 -08001680 obj_request->xferred = osd_req->r_reply_op_len[0];
Alex Elder8b3e1a52013-01-24 16:13:36 -06001681 rbd_assert(obj_request->xferred < (u64)UINT_MAX);
Alex Elder79528732013-04-03 21:32:51 -05001682 opcode = osd_req->r_ops[0].op;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001683 switch (opcode) {
1684 case CEPH_OSD_OP_READ:
Alex Elderc47f9372013-02-26 14:23:07 -06001685 rbd_osd_read_callback(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001686 break;
1687 case CEPH_OSD_OP_WRITE:
Alex Elderc47f9372013-02-26 14:23:07 -06001688 rbd_osd_write_callback(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001689 break;
Alex Elderfbfab532013-02-08 09:55:48 -06001690 case CEPH_OSD_OP_STAT:
Alex Elderc47f9372013-02-26 14:23:07 -06001691 rbd_osd_stat_callback(obj_request);
Alex Elderfbfab532013-02-08 09:55:48 -06001692 break;
Alex Elder36be9a72013-01-19 00:30:28 -06001693 case CEPH_OSD_OP_CALL:
Alex Elderb8d70032012-11-30 17:53:04 -06001694 case CEPH_OSD_OP_NOTIFY_ACK:
Alex Elder9969ebc2013-01-18 12:31:10 -06001695 case CEPH_OSD_OP_WATCH:
Alex Elderc47f9372013-02-26 14:23:07 -06001696 rbd_osd_trivial_callback(obj_request);
Alex Elder9969ebc2013-01-18 12:31:10 -06001697 break;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001698 default:
1699 rbd_warn(NULL, "%s: unsupported op %hu\n",
1700 obj_request->object_name, (unsigned short) opcode);
1701 break;
1702 }
1703
Alex Elder07741302013-02-05 23:41:50 -06001704 if (obj_request_done_test(obj_request))
Alex Elderbf0d5f502012-11-22 00:00:08 -06001705 rbd_obj_request_complete(obj_request);
1706}
1707
Alex Elder9d4df012013-04-19 15:34:50 -05001708static void rbd_osd_req_format_read(struct rbd_obj_request *obj_request)
Alex Elder430c28c2013-04-03 21:32:51 -05001709{
1710 struct rbd_img_request *img_request = obj_request->img_request;
Alex Elder8c042b02013-04-03 01:28:58 -05001711 struct ceph_osd_request *osd_req = obj_request->osd_req;
Alex Elder9d4df012013-04-19 15:34:50 -05001712 u64 snap_id;
Alex Elder430c28c2013-04-03 21:32:51 -05001713
Alex Elder8c042b02013-04-03 01:28:58 -05001714 rbd_assert(osd_req != NULL);
Alex Elder430c28c2013-04-03 21:32:51 -05001715
Alex Elder9d4df012013-04-19 15:34:50 -05001716 snap_id = img_request ? img_request->snap_id : CEPH_NOSNAP;
Alex Elder8c042b02013-04-03 01:28:58 -05001717 ceph_osdc_build_request(osd_req, obj_request->offset,
Alex Elder9d4df012013-04-19 15:34:50 -05001718 NULL, snap_id, NULL);
1719}
1720
1721static void rbd_osd_req_format_write(struct rbd_obj_request *obj_request)
1722{
1723 struct rbd_img_request *img_request = obj_request->img_request;
1724 struct ceph_osd_request *osd_req = obj_request->osd_req;
1725 struct ceph_snap_context *snapc;
1726 struct timespec mtime = CURRENT_TIME;
1727
1728 rbd_assert(osd_req != NULL);
1729
1730 snapc = img_request ? img_request->snapc : NULL;
1731 ceph_osdc_build_request(osd_req, obj_request->offset,
1732 snapc, CEPH_NOSNAP, &mtime);
Alex Elder430c28c2013-04-03 21:32:51 -05001733}
1734
Alex Elderbf0d5f502012-11-22 00:00:08 -06001735static struct ceph_osd_request *rbd_osd_req_create(
1736 struct rbd_device *rbd_dev,
1737 bool write_request,
Alex Elder430c28c2013-04-03 21:32:51 -05001738 struct rbd_obj_request *obj_request)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001739{
Alex Elderbf0d5f502012-11-22 00:00:08 -06001740 struct ceph_snap_context *snapc = NULL;
1741 struct ceph_osd_client *osdc;
1742 struct ceph_osd_request *osd_req;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001743
Alex Elder6365d332013-02-11 12:33:24 -06001744 if (obj_request_img_data_test(obj_request)) {
1745 struct rbd_img_request *img_request = obj_request->img_request;
1746
Alex Elder0c425242013-02-08 09:55:49 -06001747 rbd_assert(write_request ==
1748 img_request_write_test(img_request));
1749 if (write_request)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001750 snapc = img_request->snapc;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001751 }
1752
1753 /* Allocate and initialize the request, for the single op */
1754
1755 osdc = &rbd_dev->rbd_client->client->osdc;
1756 osd_req = ceph_osdc_alloc_request(osdc, snapc, 1, false, GFP_ATOMIC);
1757 if (!osd_req)
1758 return NULL; /* ENOMEM */
Alex Elderbf0d5f502012-11-22 00:00:08 -06001759
Alex Elder430c28c2013-04-03 21:32:51 -05001760 if (write_request)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001761 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
Alex Elder430c28c2013-04-03 21:32:51 -05001762 else
Alex Elderbf0d5f502012-11-22 00:00:08 -06001763 osd_req->r_flags = CEPH_OSD_FLAG_READ;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001764
1765 osd_req->r_callback = rbd_osd_req_callback;
1766 osd_req->r_priv = obj_request;
1767
1768 osd_req->r_oid_len = strlen(obj_request->object_name);
1769 rbd_assert(osd_req->r_oid_len < sizeof (osd_req->r_oid));
1770 memcpy(osd_req->r_oid, obj_request->object_name, osd_req->r_oid_len);
1771
1772 osd_req->r_file_layout = rbd_dev->layout; /* struct */
1773
Alex Elderbf0d5f502012-11-22 00:00:08 -06001774 return osd_req;
1775}
1776
Alex Elder0eefd472013-04-19 15:34:50 -05001777/*
1778 * Create a copyup osd request based on the information in the
1779 * object request supplied. A copyup request has two osd ops,
1780 * a copyup method call, and a "normal" write request.
1781 */
1782static struct ceph_osd_request *
1783rbd_osd_req_create_copyup(struct rbd_obj_request *obj_request)
1784{
1785 struct rbd_img_request *img_request;
1786 struct ceph_snap_context *snapc;
1787 struct rbd_device *rbd_dev;
1788 struct ceph_osd_client *osdc;
1789 struct ceph_osd_request *osd_req;
1790
1791 rbd_assert(obj_request_img_data_test(obj_request));
1792 img_request = obj_request->img_request;
1793 rbd_assert(img_request);
1794 rbd_assert(img_request_write_test(img_request));
1795
1796 /* Allocate and initialize the request, for the two ops */
1797
1798 snapc = img_request->snapc;
1799 rbd_dev = img_request->rbd_dev;
1800 osdc = &rbd_dev->rbd_client->client->osdc;
1801 osd_req = ceph_osdc_alloc_request(osdc, snapc, 2, false, GFP_ATOMIC);
1802 if (!osd_req)
1803 return NULL; /* ENOMEM */
1804
1805 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
1806 osd_req->r_callback = rbd_osd_req_callback;
1807 osd_req->r_priv = obj_request;
1808
1809 osd_req->r_oid_len = strlen(obj_request->object_name);
1810 rbd_assert(osd_req->r_oid_len < sizeof (osd_req->r_oid));
1811 memcpy(osd_req->r_oid, obj_request->object_name, osd_req->r_oid_len);
1812
1813 osd_req->r_file_layout = rbd_dev->layout; /* struct */
1814
1815 return osd_req;
1816}
1817
1818
Alex Elderbf0d5f502012-11-22 00:00:08 -06001819static void rbd_osd_req_destroy(struct ceph_osd_request *osd_req)
1820{
1821 ceph_osdc_put_request(osd_req);
1822}
1823
1824/* object_name is assumed to be a non-null pointer and NUL-terminated */
1825
1826static struct rbd_obj_request *rbd_obj_request_create(const char *object_name,
1827 u64 offset, u64 length,
1828 enum obj_request_type type)
1829{
1830 struct rbd_obj_request *obj_request;
1831 size_t size;
1832 char *name;
1833
1834 rbd_assert(obj_request_type_valid(type));
1835
1836 size = strlen(object_name) + 1;
Alex Elderf907ad52013-05-01 12:43:03 -05001837 name = kmalloc(size, GFP_KERNEL);
1838 if (!name)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001839 return NULL;
1840
Alex Elder868311b2013-05-01 12:43:03 -05001841 obj_request = kmem_cache_zalloc(rbd_obj_request_cache, GFP_KERNEL);
Alex Elderf907ad52013-05-01 12:43:03 -05001842 if (!obj_request) {
1843 kfree(name);
1844 return NULL;
1845 }
1846
Alex Elderbf0d5f502012-11-22 00:00:08 -06001847 obj_request->object_name = memcpy(name, object_name, size);
1848 obj_request->offset = offset;
1849 obj_request->length = length;
Alex Elder926f9b32013-02-11 12:33:24 -06001850 obj_request->flags = 0;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001851 obj_request->which = BAD_WHICH;
1852 obj_request->type = type;
1853 INIT_LIST_HEAD(&obj_request->links);
Alex Elder788e2df2013-01-17 12:25:27 -06001854 init_completion(&obj_request->completion);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001855 kref_init(&obj_request->kref);
1856
Alex Elder37206ee2013-02-20 17:32:08 -06001857 dout("%s: \"%s\" %llu/%llu %d -> obj %p\n", __func__, object_name,
1858 offset, length, (int)type, obj_request);
1859
Alex Elderbf0d5f502012-11-22 00:00:08 -06001860 return obj_request;
1861}
1862
1863static void rbd_obj_request_destroy(struct kref *kref)
1864{
1865 struct rbd_obj_request *obj_request;
1866
1867 obj_request = container_of(kref, struct rbd_obj_request, kref);
1868
Alex Elder37206ee2013-02-20 17:32:08 -06001869 dout("%s: obj %p\n", __func__, obj_request);
1870
Alex Elderbf0d5f502012-11-22 00:00:08 -06001871 rbd_assert(obj_request->img_request == NULL);
1872 rbd_assert(obj_request->which == BAD_WHICH);
1873
1874 if (obj_request->osd_req)
1875 rbd_osd_req_destroy(obj_request->osd_req);
1876
1877 rbd_assert(obj_request_type_valid(obj_request->type));
1878 switch (obj_request->type) {
Alex Elder9969ebc2013-01-18 12:31:10 -06001879 case OBJ_REQUEST_NODATA:
1880 break; /* Nothing to do */
Alex Elderbf0d5f502012-11-22 00:00:08 -06001881 case OBJ_REQUEST_BIO:
1882 if (obj_request->bio_list)
1883 bio_chain_put(obj_request->bio_list);
1884 break;
Alex Elder788e2df2013-01-17 12:25:27 -06001885 case OBJ_REQUEST_PAGES:
1886 if (obj_request->pages)
1887 ceph_release_page_vector(obj_request->pages,
1888 obj_request->page_count);
1889 break;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001890 }
1891
Alex Elderf907ad52013-05-01 12:43:03 -05001892 kfree(obj_request->object_name);
Alex Elder868311b2013-05-01 12:43:03 -05001893 obj_request->object_name = NULL;
1894 kmem_cache_free(rbd_obj_request_cache, obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001895}
1896
Alex Elderfb65d2282013-05-08 22:50:04 -05001897/* It's OK to call this for a device with no parent */
1898
1899static void rbd_spec_put(struct rbd_spec *spec);
1900static void rbd_dev_unparent(struct rbd_device *rbd_dev)
1901{
1902 rbd_dev_remove_parent(rbd_dev);
1903 rbd_spec_put(rbd_dev->parent_spec);
1904 rbd_dev->parent_spec = NULL;
1905 rbd_dev->parent_overlap = 0;
1906}
1907
Alex Elderbf0d5f502012-11-22 00:00:08 -06001908/*
Alex Eldera2acd002013-05-08 22:50:04 -05001909 * Parent image reference counting is used to determine when an
1910 * image's parent fields can be safely torn down--after there are no
1911 * more in-flight requests to the parent image. When the last
1912 * reference is dropped, cleaning them up is safe.
1913 */
1914static void rbd_dev_parent_put(struct rbd_device *rbd_dev)
1915{
1916 int counter;
1917
1918 if (!rbd_dev->parent_spec)
1919 return;
1920
1921 counter = atomic_dec_return_safe(&rbd_dev->parent_ref);
1922 if (counter > 0)
1923 return;
1924
1925 /* Last reference; clean up parent data structures */
1926
1927 if (!counter)
1928 rbd_dev_unparent(rbd_dev);
1929 else
1930 rbd_warn(rbd_dev, "parent reference underflow\n");
1931}
1932
1933/*
1934 * If an image has a non-zero parent overlap, get a reference to its
1935 * parent.
1936 *
Alex Elder392a9da2013-05-06 17:40:33 -05001937 * We must get the reference before checking for the overlap to
1938 * coordinate properly with zeroing the parent overlap in
1939 * rbd_dev_v2_parent_info() when an image gets flattened. We
1940 * drop it again if there is no overlap.
1941 *
Alex Eldera2acd002013-05-08 22:50:04 -05001942 * Returns true if the rbd device has a parent with a non-zero
1943 * overlap and a reference for it was successfully taken, or
1944 * false otherwise.
1945 */
1946static bool rbd_dev_parent_get(struct rbd_device *rbd_dev)
1947{
1948 int counter;
1949
1950 if (!rbd_dev->parent_spec)
1951 return false;
1952
1953 counter = atomic_inc_return_safe(&rbd_dev->parent_ref);
1954 if (counter > 0 && rbd_dev->parent_overlap)
1955 return true;
1956
1957 /* Image was flattened, but parent is not yet torn down */
1958
1959 if (counter < 0)
1960 rbd_warn(rbd_dev, "parent reference overflow\n");
1961
1962 return false;
1963}
1964
1965/*
Alex Elderbf0d5f502012-11-22 00:00:08 -06001966 * Caller is responsible for filling in the list of object requests
1967 * that comprises the image request, and the Linux request pointer
1968 * (if there is one).
1969 */
Alex Eldercc344fa2013-02-19 12:25:56 -06001970static struct rbd_img_request *rbd_img_request_create(
1971 struct rbd_device *rbd_dev,
Alex Elderbf0d5f502012-11-22 00:00:08 -06001972 u64 offset, u64 length,
Alex Eldere93f3152013-05-08 22:50:04 -05001973 bool write_request)
Alex Elderbf0d5f502012-11-22 00:00:08 -06001974{
1975 struct rbd_img_request *img_request;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001976
Alex Elder1c2a9df2013-05-01 12:43:03 -05001977 img_request = kmem_cache_alloc(rbd_img_request_cache, GFP_ATOMIC);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001978 if (!img_request)
1979 return NULL;
1980
1981 if (write_request) {
1982 down_read(&rbd_dev->header_rwsem);
Alex Elder812164f82013-04-30 00:44:32 -05001983 ceph_get_snap_context(rbd_dev->header.snapc);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001984 up_read(&rbd_dev->header_rwsem);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001985 }
1986
1987 img_request->rq = NULL;
1988 img_request->rbd_dev = rbd_dev;
1989 img_request->offset = offset;
1990 img_request->length = length;
Alex Elder0c425242013-02-08 09:55:49 -06001991 img_request->flags = 0;
1992 if (write_request) {
1993 img_request_write_set(img_request);
Alex Elder468521c2013-04-26 09:43:47 -05001994 img_request->snapc = rbd_dev->header.snapc;
Alex Elder0c425242013-02-08 09:55:49 -06001995 } else {
Alex Elderbf0d5f502012-11-22 00:00:08 -06001996 img_request->snap_id = rbd_dev->spec->snap_id;
Alex Elder0c425242013-02-08 09:55:49 -06001997 }
Alex Eldera2acd002013-05-08 22:50:04 -05001998 if (rbd_dev_parent_get(rbd_dev))
Alex Elderd0b2e942013-01-24 16:13:36 -06001999 img_request_layered_set(img_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002000 spin_lock_init(&img_request->completion_lock);
2001 img_request->next_completion = 0;
2002 img_request->callback = NULL;
Alex Eldera5a337d2013-01-24 16:13:36 -06002003 img_request->result = 0;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002004 img_request->obj_request_count = 0;
2005 INIT_LIST_HEAD(&img_request->obj_requests);
2006 kref_init(&img_request->kref);
2007
Alex Elder37206ee2013-02-20 17:32:08 -06002008 dout("%s: rbd_dev %p %s %llu/%llu -> img %p\n", __func__, rbd_dev,
2009 write_request ? "write" : "read", offset, length,
2010 img_request);
2011
Alex Elderbf0d5f502012-11-22 00:00:08 -06002012 return img_request;
2013}
2014
2015static void rbd_img_request_destroy(struct kref *kref)
2016{
2017 struct rbd_img_request *img_request;
2018 struct rbd_obj_request *obj_request;
2019 struct rbd_obj_request *next_obj_request;
2020
2021 img_request = container_of(kref, struct rbd_img_request, kref);
2022
Alex Elder37206ee2013-02-20 17:32:08 -06002023 dout("%s: img %p\n", __func__, img_request);
2024
Alex Elderbf0d5f502012-11-22 00:00:08 -06002025 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2026 rbd_img_obj_request_del(img_request, obj_request);
Alex Elder25dcf952013-01-25 17:08:55 -06002027 rbd_assert(img_request->obj_request_count == 0);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002028
Alex Eldera2acd002013-05-08 22:50:04 -05002029 if (img_request_layered_test(img_request)) {
2030 img_request_layered_clear(img_request);
2031 rbd_dev_parent_put(img_request->rbd_dev);
2032 }
2033
Alex Elder0c425242013-02-08 09:55:49 -06002034 if (img_request_write_test(img_request))
Alex Elder812164f82013-04-30 00:44:32 -05002035 ceph_put_snap_context(img_request->snapc);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002036
Alex Elder1c2a9df2013-05-01 12:43:03 -05002037 kmem_cache_free(rbd_img_request_cache, img_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002038}
2039
Alex Eldere93f3152013-05-08 22:50:04 -05002040static struct rbd_img_request *rbd_parent_request_create(
2041 struct rbd_obj_request *obj_request,
2042 u64 img_offset, u64 length)
2043{
2044 struct rbd_img_request *parent_request;
2045 struct rbd_device *rbd_dev;
2046
2047 rbd_assert(obj_request->img_request);
2048 rbd_dev = obj_request->img_request->rbd_dev;
2049
2050 parent_request = rbd_img_request_create(rbd_dev->parent,
2051 img_offset, length, false);
2052 if (!parent_request)
2053 return NULL;
2054
2055 img_request_child_set(parent_request);
2056 rbd_obj_request_get(obj_request);
2057 parent_request->obj_request = obj_request;
2058
2059 return parent_request;
2060}
2061
2062static void rbd_parent_request_destroy(struct kref *kref)
2063{
2064 struct rbd_img_request *parent_request;
2065 struct rbd_obj_request *orig_request;
2066
2067 parent_request = container_of(kref, struct rbd_img_request, kref);
2068 orig_request = parent_request->obj_request;
2069
2070 parent_request->obj_request = NULL;
2071 rbd_obj_request_put(orig_request);
2072 img_request_child_clear(parent_request);
2073
2074 rbd_img_request_destroy(kref);
2075}
2076
Alex Elder12178572013-02-08 09:55:49 -06002077static bool rbd_img_obj_end_request(struct rbd_obj_request *obj_request)
2078{
Alex Elder6365d332013-02-11 12:33:24 -06002079 struct rbd_img_request *img_request;
Alex Elder12178572013-02-08 09:55:49 -06002080 unsigned int xferred;
2081 int result;
Alex Elder8b3e1a52013-01-24 16:13:36 -06002082 bool more;
Alex Elder12178572013-02-08 09:55:49 -06002083
Alex Elder6365d332013-02-11 12:33:24 -06002084 rbd_assert(obj_request_img_data_test(obj_request));
2085 img_request = obj_request->img_request;
2086
Alex Elder12178572013-02-08 09:55:49 -06002087 rbd_assert(obj_request->xferred <= (u64)UINT_MAX);
2088 xferred = (unsigned int)obj_request->xferred;
2089 result = obj_request->result;
2090 if (result) {
2091 struct rbd_device *rbd_dev = img_request->rbd_dev;
2092
2093 rbd_warn(rbd_dev, "%s %llx at %llx (%llx)\n",
2094 img_request_write_test(img_request) ? "write" : "read",
2095 obj_request->length, obj_request->img_offset,
2096 obj_request->offset);
2097 rbd_warn(rbd_dev, " result %d xferred %x\n",
2098 result, xferred);
2099 if (!img_request->result)
2100 img_request->result = result;
2101 }
2102
Alex Elderf1a47392013-04-19 15:34:50 -05002103 /* Image object requests don't own their page array */
2104
2105 if (obj_request->type == OBJ_REQUEST_PAGES) {
2106 obj_request->pages = NULL;
2107 obj_request->page_count = 0;
2108 }
2109
Alex Elder8b3e1a52013-01-24 16:13:36 -06002110 if (img_request_child_test(img_request)) {
2111 rbd_assert(img_request->obj_request != NULL);
2112 more = obj_request->which < img_request->obj_request_count - 1;
2113 } else {
2114 rbd_assert(img_request->rq != NULL);
2115 more = blk_end_request(img_request->rq, result, xferred);
2116 }
2117
2118 return more;
Alex Elder12178572013-02-08 09:55:49 -06002119}
2120
Alex Elder21692382013-04-05 01:27:12 -05002121static void rbd_img_obj_callback(struct rbd_obj_request *obj_request)
2122{
2123 struct rbd_img_request *img_request;
2124 u32 which = obj_request->which;
2125 bool more = true;
2126
Alex Elder6365d332013-02-11 12:33:24 -06002127 rbd_assert(obj_request_img_data_test(obj_request));
Alex Elder21692382013-04-05 01:27:12 -05002128 img_request = obj_request->img_request;
2129
2130 dout("%s: img %p obj %p\n", __func__, img_request, obj_request);
2131 rbd_assert(img_request != NULL);
Alex Elder21692382013-04-05 01:27:12 -05002132 rbd_assert(img_request->obj_request_count > 0);
2133 rbd_assert(which != BAD_WHICH);
2134 rbd_assert(which < img_request->obj_request_count);
2135 rbd_assert(which >= img_request->next_completion);
2136
2137 spin_lock_irq(&img_request->completion_lock);
2138 if (which != img_request->next_completion)
2139 goto out;
2140
2141 for_each_obj_request_from(img_request, obj_request) {
Alex Elder21692382013-04-05 01:27:12 -05002142 rbd_assert(more);
2143 rbd_assert(which < img_request->obj_request_count);
2144
2145 if (!obj_request_done_test(obj_request))
2146 break;
Alex Elder12178572013-02-08 09:55:49 -06002147 more = rbd_img_obj_end_request(obj_request);
Alex Elder21692382013-04-05 01:27:12 -05002148 which++;
2149 }
2150
2151 rbd_assert(more ^ (which == img_request->obj_request_count));
2152 img_request->next_completion = which;
2153out:
2154 spin_unlock_irq(&img_request->completion_lock);
2155
2156 if (!more)
2157 rbd_img_request_complete(img_request);
2158}
2159
Alex Elderf1a47392013-04-19 15:34:50 -05002160/*
2161 * Split up an image request into one or more object requests, each
2162 * to a different object. The "type" parameter indicates whether
2163 * "data_desc" is the pointer to the head of a list of bio
2164 * structures, or the base of a page array. In either case this
2165 * function assumes data_desc describes memory sufficient to hold
2166 * all data described by the image request.
2167 */
2168static int rbd_img_request_fill(struct rbd_img_request *img_request,
2169 enum obj_request_type type,
2170 void *data_desc)
Alex Elderbf0d5f502012-11-22 00:00:08 -06002171{
2172 struct rbd_device *rbd_dev = img_request->rbd_dev;
2173 struct rbd_obj_request *obj_request = NULL;
2174 struct rbd_obj_request *next_obj_request;
Alex Elder0c425242013-02-08 09:55:49 -06002175 bool write_request = img_request_write_test(img_request);
Alex Elderf1a47392013-04-19 15:34:50 -05002176 struct bio *bio_list;
2177 unsigned int bio_offset = 0;
2178 struct page **pages;
Alex Elder7da22d22013-01-24 16:13:36 -06002179 u64 img_offset;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002180 u64 resid;
2181 u16 opcode;
2182
Alex Elderf1a47392013-04-19 15:34:50 -05002183 dout("%s: img %p type %d data_desc %p\n", __func__, img_request,
2184 (int)type, data_desc);
Alex Elder37206ee2013-02-20 17:32:08 -06002185
Alex Elder430c28c2013-04-03 21:32:51 -05002186 opcode = write_request ? CEPH_OSD_OP_WRITE : CEPH_OSD_OP_READ;
Alex Elder7da22d22013-01-24 16:13:36 -06002187 img_offset = img_request->offset;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002188 resid = img_request->length;
Alex Elder4dda41d2013-02-20 21:59:33 -06002189 rbd_assert(resid > 0);
Alex Elderf1a47392013-04-19 15:34:50 -05002190
2191 if (type == OBJ_REQUEST_BIO) {
2192 bio_list = data_desc;
2193 rbd_assert(img_offset == bio_list->bi_sector << SECTOR_SHIFT);
2194 } else {
2195 rbd_assert(type == OBJ_REQUEST_PAGES);
2196 pages = data_desc;
2197 }
2198
Alex Elderbf0d5f502012-11-22 00:00:08 -06002199 while (resid) {
Alex Elder2fa12322013-04-05 01:27:12 -05002200 struct ceph_osd_request *osd_req;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002201 const char *object_name;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002202 u64 offset;
2203 u64 length;
2204
Alex Elder7da22d22013-01-24 16:13:36 -06002205 object_name = rbd_segment_name(rbd_dev, img_offset);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002206 if (!object_name)
2207 goto out_unwind;
Alex Elder7da22d22013-01-24 16:13:36 -06002208 offset = rbd_segment_offset(rbd_dev, img_offset);
2209 length = rbd_segment_length(rbd_dev, img_offset, resid);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002210 obj_request = rbd_obj_request_create(object_name,
Alex Elderf1a47392013-04-19 15:34:50 -05002211 offset, length, type);
Alex Elder78c2a442013-05-01 12:43:04 -05002212 /* object request has its own copy of the object name */
2213 rbd_segment_name_free(object_name);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002214 if (!obj_request)
2215 goto out_unwind;
2216
Alex Elderf1a47392013-04-19 15:34:50 -05002217 if (type == OBJ_REQUEST_BIO) {
2218 unsigned int clone_size;
2219
2220 rbd_assert(length <= (u64)UINT_MAX);
2221 clone_size = (unsigned int)length;
2222 obj_request->bio_list =
2223 bio_chain_clone_range(&bio_list,
2224 &bio_offset,
2225 clone_size,
2226 GFP_ATOMIC);
2227 if (!obj_request->bio_list)
2228 goto out_partial;
2229 } else {
2230 unsigned int page_count;
2231
2232 obj_request->pages = pages;
2233 page_count = (u32)calc_pages_for(offset, length);
2234 obj_request->page_count = page_count;
2235 if ((offset + length) & ~PAGE_MASK)
2236 page_count--; /* more on last page */
2237 pages += page_count;
2238 }
Alex Elderbf0d5f502012-11-22 00:00:08 -06002239
Alex Elder2fa12322013-04-05 01:27:12 -05002240 osd_req = rbd_osd_req_create(rbd_dev, write_request,
2241 obj_request);
2242 if (!osd_req)
Alex Elderbf0d5f502012-11-22 00:00:08 -06002243 goto out_partial;
Alex Elder2fa12322013-04-05 01:27:12 -05002244 obj_request->osd_req = osd_req;
Alex Elder21692382013-04-05 01:27:12 -05002245 obj_request->callback = rbd_img_obj_callback;
Alex Elder430c28c2013-04-03 21:32:51 -05002246
Alex Elder2fa12322013-04-05 01:27:12 -05002247 osd_req_op_extent_init(osd_req, 0, opcode, offset, length,
2248 0, 0);
Alex Elderf1a47392013-04-19 15:34:50 -05002249 if (type == OBJ_REQUEST_BIO)
2250 osd_req_op_extent_osd_data_bio(osd_req, 0,
2251 obj_request->bio_list, length);
2252 else
2253 osd_req_op_extent_osd_data_pages(osd_req, 0,
2254 obj_request->pages, length,
2255 offset & ~PAGE_MASK, false, false);
Alex Elder9d4df012013-04-19 15:34:50 -05002256
2257 if (write_request)
2258 rbd_osd_req_format_write(obj_request);
2259 else
2260 rbd_osd_req_format_read(obj_request);
Alex Elder430c28c2013-04-03 21:32:51 -05002261
Alex Elder7da22d22013-01-24 16:13:36 -06002262 obj_request->img_offset = img_offset;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002263 rbd_img_obj_request_add(img_request, obj_request);
2264
Alex Elder7da22d22013-01-24 16:13:36 -06002265 img_offset += length;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002266 resid -= length;
2267 }
2268
2269 return 0;
2270
2271out_partial:
2272 rbd_obj_request_put(obj_request);
2273out_unwind:
2274 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2275 rbd_obj_request_put(obj_request);
2276
2277 return -ENOMEM;
2278}
2279
Alex Elder3d7efd12013-04-19 15:34:50 -05002280static void
Alex Elder0eefd472013-04-19 15:34:50 -05002281rbd_img_obj_copyup_callback(struct rbd_obj_request *obj_request)
2282{
2283 struct rbd_img_request *img_request;
2284 struct rbd_device *rbd_dev;
Alex Elderebda6402013-05-10 16:29:22 -05002285 struct page **pages;
Alex Elder0eefd472013-04-19 15:34:50 -05002286 u32 page_count;
2287
2288 rbd_assert(obj_request->type == OBJ_REQUEST_BIO);
2289 rbd_assert(obj_request_img_data_test(obj_request));
2290 img_request = obj_request->img_request;
2291 rbd_assert(img_request);
2292
2293 rbd_dev = img_request->rbd_dev;
2294 rbd_assert(rbd_dev);
Alex Elder0eefd472013-04-19 15:34:50 -05002295
Alex Elderebda6402013-05-10 16:29:22 -05002296 pages = obj_request->copyup_pages;
2297 rbd_assert(pages != NULL);
Alex Elder0eefd472013-04-19 15:34:50 -05002298 obj_request->copyup_pages = NULL;
Alex Elderebda6402013-05-10 16:29:22 -05002299 page_count = obj_request->copyup_page_count;
2300 rbd_assert(page_count);
2301 obj_request->copyup_page_count = 0;
2302 ceph_release_page_vector(pages, page_count);
Alex Elder0eefd472013-04-19 15:34:50 -05002303
2304 /*
2305 * We want the transfer count to reflect the size of the
2306 * original write request. There is no such thing as a
2307 * successful short write, so if the request was successful
2308 * we can just set it to the originally-requested length.
2309 */
2310 if (!obj_request->result)
2311 obj_request->xferred = obj_request->length;
2312
2313 /* Finish up with the normal image object callback */
2314
2315 rbd_img_obj_callback(obj_request);
2316}
2317
2318static void
Alex Elder3d7efd12013-04-19 15:34:50 -05002319rbd_img_obj_parent_read_full_callback(struct rbd_img_request *img_request)
2320{
2321 struct rbd_obj_request *orig_request;
Alex Elder0eefd472013-04-19 15:34:50 -05002322 struct ceph_osd_request *osd_req;
2323 struct ceph_osd_client *osdc;
2324 struct rbd_device *rbd_dev;
Alex Elder3d7efd12013-04-19 15:34:50 -05002325 struct page **pages;
Alex Elderebda6402013-05-10 16:29:22 -05002326 u32 page_count;
Alex Elderbbea1c12013-05-06 17:40:33 -05002327 int img_result;
Alex Elderebda6402013-05-10 16:29:22 -05002328 u64 parent_length;
Alex Elderb91f09f2013-05-10 16:29:22 -05002329 u64 offset;
2330 u64 length;
Alex Elder3d7efd12013-04-19 15:34:50 -05002331
2332 rbd_assert(img_request_child_test(img_request));
2333
2334 /* First get what we need from the image request */
2335
2336 pages = img_request->copyup_pages;
2337 rbd_assert(pages != NULL);
2338 img_request->copyup_pages = NULL;
Alex Elderebda6402013-05-10 16:29:22 -05002339 page_count = img_request->copyup_page_count;
2340 rbd_assert(page_count);
2341 img_request->copyup_page_count = 0;
Alex Elder3d7efd12013-04-19 15:34:50 -05002342
2343 orig_request = img_request->obj_request;
2344 rbd_assert(orig_request != NULL);
Alex Elderb91f09f2013-05-10 16:29:22 -05002345 rbd_assert(obj_request_type_valid(orig_request->type));
Alex Elderbbea1c12013-05-06 17:40:33 -05002346 img_result = img_request->result;
Alex Elderebda6402013-05-10 16:29:22 -05002347 parent_length = img_request->length;
2348 rbd_assert(parent_length == img_request->xferred);
Alex Elder91c6feb2013-05-06 17:40:32 -05002349 rbd_img_request_put(img_request);
Alex Elder3d7efd12013-04-19 15:34:50 -05002350
Alex Elder91c6feb2013-05-06 17:40:32 -05002351 rbd_assert(orig_request->img_request);
2352 rbd_dev = orig_request->img_request->rbd_dev;
Alex Elder0eefd472013-04-19 15:34:50 -05002353 rbd_assert(rbd_dev);
Alex Elder0eefd472013-04-19 15:34:50 -05002354
Alex Elderbbea1c12013-05-06 17:40:33 -05002355 /*
2356 * If the overlap has become 0 (most likely because the
2357 * image has been flattened) we need to free the pages
2358 * and re-submit the original write request.
2359 */
2360 if (!rbd_dev->parent_overlap) {
2361 struct ceph_osd_client *osdc;
2362
2363 ceph_release_page_vector(pages, page_count);
2364 osdc = &rbd_dev->rbd_client->client->osdc;
2365 img_result = rbd_obj_request_submit(osdc, orig_request);
2366 if (!img_result)
2367 return;
2368 }
2369
2370 if (img_result)
Alex Elder0eefd472013-04-19 15:34:50 -05002371 goto out_err;
Alex Elder3d7efd12013-04-19 15:34:50 -05002372
Alex Elder8785b1d2013-05-09 10:08:49 -05002373 /*
2374 * The original osd request is of no use to use any more.
2375 * We need a new one that can hold the two ops in a copyup
2376 * request. Allocate the new copyup osd request for the
2377 * original request, and release the old one.
2378 */
Alex Elderbbea1c12013-05-06 17:40:33 -05002379 img_result = -ENOMEM;
Alex Elder0eefd472013-04-19 15:34:50 -05002380 osd_req = rbd_osd_req_create_copyup(orig_request);
2381 if (!osd_req)
2382 goto out_err;
Alex Elder8785b1d2013-05-09 10:08:49 -05002383 rbd_osd_req_destroy(orig_request->osd_req);
Alex Elder0eefd472013-04-19 15:34:50 -05002384 orig_request->osd_req = osd_req;
2385 orig_request->copyup_pages = pages;
Alex Elderebda6402013-05-10 16:29:22 -05002386 orig_request->copyup_page_count = page_count;
Alex Elder3d7efd12013-04-19 15:34:50 -05002387
Alex Elder0eefd472013-04-19 15:34:50 -05002388 /* Initialize the copyup op */
2389
2390 osd_req_op_cls_init(osd_req, 0, CEPH_OSD_OP_CALL, "rbd", "copyup");
Alex Elderebda6402013-05-10 16:29:22 -05002391 osd_req_op_cls_request_data_pages(osd_req, 0, pages, parent_length, 0,
Alex Elder0eefd472013-04-19 15:34:50 -05002392 false, false);
2393
2394 /* Then the original write request op */
2395
Alex Elderb91f09f2013-05-10 16:29:22 -05002396 offset = orig_request->offset;
2397 length = orig_request->length;
Alex Elder0eefd472013-04-19 15:34:50 -05002398 osd_req_op_extent_init(osd_req, 1, CEPH_OSD_OP_WRITE,
Alex Elderb91f09f2013-05-10 16:29:22 -05002399 offset, length, 0, 0);
2400 if (orig_request->type == OBJ_REQUEST_BIO)
2401 osd_req_op_extent_osd_data_bio(osd_req, 1,
2402 orig_request->bio_list, length);
2403 else
2404 osd_req_op_extent_osd_data_pages(osd_req, 1,
2405 orig_request->pages, length,
2406 offset & ~PAGE_MASK, false, false);
Alex Elder0eefd472013-04-19 15:34:50 -05002407
2408 rbd_osd_req_format_write(orig_request);
2409
2410 /* All set, send it off. */
2411
2412 orig_request->callback = rbd_img_obj_copyup_callback;
2413 osdc = &rbd_dev->rbd_client->client->osdc;
Alex Elderbbea1c12013-05-06 17:40:33 -05002414 img_result = rbd_obj_request_submit(osdc, orig_request);
2415 if (!img_result)
Alex Elder0eefd472013-04-19 15:34:50 -05002416 return;
2417out_err:
2418 /* Record the error code and complete the request */
2419
Alex Elderbbea1c12013-05-06 17:40:33 -05002420 orig_request->result = img_result;
Alex Elder0eefd472013-04-19 15:34:50 -05002421 orig_request->xferred = 0;
2422 obj_request_done_set(orig_request);
2423 rbd_obj_request_complete(orig_request);
Alex Elder3d7efd12013-04-19 15:34:50 -05002424}
2425
2426/*
2427 * Read from the parent image the range of data that covers the
2428 * entire target of the given object request. This is used for
2429 * satisfying a layered image write request when the target of an
2430 * object request from the image request does not exist.
2431 *
2432 * A page array big enough to hold the returned data is allocated
2433 * and supplied to rbd_img_request_fill() as the "data descriptor."
2434 * When the read completes, this page array will be transferred to
2435 * the original object request for the copyup operation.
2436 *
2437 * If an error occurs, record it as the result of the original
2438 * object request and mark it done so it gets completed.
2439 */
2440static int rbd_img_obj_parent_read_full(struct rbd_obj_request *obj_request)
2441{
2442 struct rbd_img_request *img_request = NULL;
2443 struct rbd_img_request *parent_request = NULL;
2444 struct rbd_device *rbd_dev;
2445 u64 img_offset;
2446 u64 length;
2447 struct page **pages = NULL;
2448 u32 page_count;
2449 int result;
2450
2451 rbd_assert(obj_request_img_data_test(obj_request));
Alex Elderb91f09f2013-05-10 16:29:22 -05002452 rbd_assert(obj_request_type_valid(obj_request->type));
Alex Elder3d7efd12013-04-19 15:34:50 -05002453
2454 img_request = obj_request->img_request;
2455 rbd_assert(img_request != NULL);
2456 rbd_dev = img_request->rbd_dev;
2457 rbd_assert(rbd_dev->parent != NULL);
2458
2459 /*
2460 * Determine the byte range covered by the object in the
2461 * child image to which the original request was to be sent.
2462 */
2463 img_offset = obj_request->img_offset - obj_request->offset;
2464 length = (u64)1 << rbd_dev->header.obj_order;
2465
2466 /*
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002467 * There is no defined parent data beyond the parent
2468 * overlap, so limit what we read at that boundary if
2469 * necessary.
2470 */
2471 if (img_offset + length > rbd_dev->parent_overlap) {
2472 rbd_assert(img_offset < rbd_dev->parent_overlap);
2473 length = rbd_dev->parent_overlap - img_offset;
2474 }
2475
2476 /*
Alex Elder3d7efd12013-04-19 15:34:50 -05002477 * Allocate a page array big enough to receive the data read
2478 * from the parent.
2479 */
2480 page_count = (u32)calc_pages_for(0, length);
2481 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2482 if (IS_ERR(pages)) {
2483 result = PTR_ERR(pages);
2484 pages = NULL;
2485 goto out_err;
2486 }
2487
2488 result = -ENOMEM;
Alex Eldere93f3152013-05-08 22:50:04 -05002489 parent_request = rbd_parent_request_create(obj_request,
2490 img_offset, length);
Alex Elder3d7efd12013-04-19 15:34:50 -05002491 if (!parent_request)
2492 goto out_err;
Alex Elder3d7efd12013-04-19 15:34:50 -05002493
2494 result = rbd_img_request_fill(parent_request, OBJ_REQUEST_PAGES, pages);
2495 if (result)
2496 goto out_err;
2497 parent_request->copyup_pages = pages;
Alex Elderebda6402013-05-10 16:29:22 -05002498 parent_request->copyup_page_count = page_count;
Alex Elder3d7efd12013-04-19 15:34:50 -05002499
2500 parent_request->callback = rbd_img_obj_parent_read_full_callback;
2501 result = rbd_img_request_submit(parent_request);
2502 if (!result)
2503 return 0;
2504
2505 parent_request->copyup_pages = NULL;
Alex Elderebda6402013-05-10 16:29:22 -05002506 parent_request->copyup_page_count = 0;
Alex Elder3d7efd12013-04-19 15:34:50 -05002507 parent_request->obj_request = NULL;
2508 rbd_obj_request_put(obj_request);
2509out_err:
2510 if (pages)
2511 ceph_release_page_vector(pages, page_count);
2512 if (parent_request)
2513 rbd_img_request_put(parent_request);
2514 obj_request->result = result;
2515 obj_request->xferred = 0;
2516 obj_request_done_set(obj_request);
2517
2518 return result;
2519}
2520
Alex Elderc5b5ef62013-02-11 12:33:24 -06002521static void rbd_img_obj_exists_callback(struct rbd_obj_request *obj_request)
2522{
Alex Elderc5b5ef62013-02-11 12:33:24 -06002523 struct rbd_obj_request *orig_request;
Alex Elder638f5ab2013-05-06 17:40:33 -05002524 struct rbd_device *rbd_dev;
Alex Elderc5b5ef62013-02-11 12:33:24 -06002525 int result;
2526
2527 rbd_assert(!obj_request_img_data_test(obj_request));
2528
2529 /*
2530 * All we need from the object request is the original
2531 * request and the result of the STAT op. Grab those, then
2532 * we're done with the request.
2533 */
2534 orig_request = obj_request->obj_request;
2535 obj_request->obj_request = NULL;
2536 rbd_assert(orig_request);
2537 rbd_assert(orig_request->img_request);
2538
2539 result = obj_request->result;
2540 obj_request->result = 0;
2541
2542 dout("%s: obj %p for obj %p result %d %llu/%llu\n", __func__,
2543 obj_request, orig_request, result,
2544 obj_request->xferred, obj_request->length);
2545 rbd_obj_request_put(obj_request);
2546
Alex Elder638f5ab2013-05-06 17:40:33 -05002547 /*
2548 * If the overlap has become 0 (most likely because the
2549 * image has been flattened) we need to free the pages
2550 * and re-submit the original write request.
2551 */
2552 rbd_dev = orig_request->img_request->rbd_dev;
2553 if (!rbd_dev->parent_overlap) {
2554 struct ceph_osd_client *osdc;
2555
2556 rbd_obj_request_put(orig_request);
2557 osdc = &rbd_dev->rbd_client->client->osdc;
2558 result = rbd_obj_request_submit(osdc, orig_request);
2559 if (!result)
2560 return;
2561 }
Alex Elderc5b5ef62013-02-11 12:33:24 -06002562
2563 /*
2564 * Our only purpose here is to determine whether the object
2565 * exists, and we don't want to treat the non-existence as
2566 * an error. If something else comes back, transfer the
2567 * error to the original request and complete it now.
2568 */
2569 if (!result) {
2570 obj_request_existence_set(orig_request, true);
2571 } else if (result == -ENOENT) {
2572 obj_request_existence_set(orig_request, false);
2573 } else if (result) {
2574 orig_request->result = result;
Alex Elder3d7efd12013-04-19 15:34:50 -05002575 goto out;
Alex Elderc5b5ef62013-02-11 12:33:24 -06002576 }
2577
2578 /*
2579 * Resubmit the original request now that we have recorded
2580 * whether the target object exists.
2581 */
Alex Elderb454e362013-04-19 15:34:50 -05002582 orig_request->result = rbd_img_obj_request_submit(orig_request);
Alex Elder3d7efd12013-04-19 15:34:50 -05002583out:
Alex Elderc5b5ef62013-02-11 12:33:24 -06002584 if (orig_request->result)
2585 rbd_obj_request_complete(orig_request);
2586 rbd_obj_request_put(orig_request);
2587}
2588
2589static int rbd_img_obj_exists_submit(struct rbd_obj_request *obj_request)
2590{
2591 struct rbd_obj_request *stat_request;
2592 struct rbd_device *rbd_dev;
2593 struct ceph_osd_client *osdc;
2594 struct page **pages = NULL;
2595 u32 page_count;
2596 size_t size;
2597 int ret;
2598
2599 /*
2600 * The response data for a STAT call consists of:
2601 * le64 length;
2602 * struct {
2603 * le32 tv_sec;
2604 * le32 tv_nsec;
2605 * } mtime;
2606 */
2607 size = sizeof (__le64) + sizeof (__le32) + sizeof (__le32);
2608 page_count = (u32)calc_pages_for(0, size);
2609 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2610 if (IS_ERR(pages))
2611 return PTR_ERR(pages);
2612
2613 ret = -ENOMEM;
2614 stat_request = rbd_obj_request_create(obj_request->object_name, 0, 0,
2615 OBJ_REQUEST_PAGES);
2616 if (!stat_request)
2617 goto out;
2618
2619 rbd_obj_request_get(obj_request);
2620 stat_request->obj_request = obj_request;
2621 stat_request->pages = pages;
2622 stat_request->page_count = page_count;
2623
2624 rbd_assert(obj_request->img_request);
2625 rbd_dev = obj_request->img_request->rbd_dev;
2626 stat_request->osd_req = rbd_osd_req_create(rbd_dev, false,
2627 stat_request);
2628 if (!stat_request->osd_req)
2629 goto out;
2630 stat_request->callback = rbd_img_obj_exists_callback;
2631
2632 osd_req_op_init(stat_request->osd_req, 0, CEPH_OSD_OP_STAT);
2633 osd_req_op_raw_data_in_pages(stat_request->osd_req, 0, pages, size, 0,
2634 false, false);
Alex Elder9d4df012013-04-19 15:34:50 -05002635 rbd_osd_req_format_read(stat_request);
Alex Elderc5b5ef62013-02-11 12:33:24 -06002636
2637 osdc = &rbd_dev->rbd_client->client->osdc;
2638 ret = rbd_obj_request_submit(osdc, stat_request);
2639out:
2640 if (ret)
2641 rbd_obj_request_put(obj_request);
2642
2643 return ret;
2644}
2645
Alex Elderb454e362013-04-19 15:34:50 -05002646static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request)
2647{
2648 struct rbd_img_request *img_request;
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002649 struct rbd_device *rbd_dev;
Alex Elder3d7efd12013-04-19 15:34:50 -05002650 bool known;
Alex Elderb454e362013-04-19 15:34:50 -05002651
2652 rbd_assert(obj_request_img_data_test(obj_request));
2653
2654 img_request = obj_request->img_request;
2655 rbd_assert(img_request);
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002656 rbd_dev = img_request->rbd_dev;
Alex Elderb454e362013-04-19 15:34:50 -05002657
Alex Elderb454e362013-04-19 15:34:50 -05002658 /*
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002659 * Only writes to layered images need special handling.
2660 * Reads and non-layered writes are simple object requests.
2661 * Layered writes that start beyond the end of the overlap
2662 * with the parent have no parent data, so they too are
2663 * simple object requests. Finally, if the target object is
2664 * known to already exist, its parent data has already been
2665 * copied, so a write to the object can also be handled as a
2666 * simple object request.
Alex Elderb454e362013-04-19 15:34:50 -05002667 */
2668 if (!img_request_write_test(img_request) ||
2669 !img_request_layered_test(img_request) ||
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002670 rbd_dev->parent_overlap <= obj_request->img_offset ||
Alex Elder3d7efd12013-04-19 15:34:50 -05002671 ((known = obj_request_known_test(obj_request)) &&
2672 obj_request_exists_test(obj_request))) {
Alex Elderb454e362013-04-19 15:34:50 -05002673
2674 struct rbd_device *rbd_dev;
2675 struct ceph_osd_client *osdc;
2676
2677 rbd_dev = obj_request->img_request->rbd_dev;
2678 osdc = &rbd_dev->rbd_client->client->osdc;
2679
2680 return rbd_obj_request_submit(osdc, obj_request);
2681 }
2682
2683 /*
Alex Elder3d7efd12013-04-19 15:34:50 -05002684 * It's a layered write. The target object might exist but
2685 * we may not know that yet. If we know it doesn't exist,
2686 * start by reading the data for the full target object from
2687 * the parent so we can use it for a copyup to the target.
Alex Elderb454e362013-04-19 15:34:50 -05002688 */
Alex Elder3d7efd12013-04-19 15:34:50 -05002689 if (known)
2690 return rbd_img_obj_parent_read_full(obj_request);
2691
2692 /* We don't know whether the target exists. Go find out. */
Alex Elderb454e362013-04-19 15:34:50 -05002693
2694 return rbd_img_obj_exists_submit(obj_request);
2695}
2696
Alex Elderbf0d5f502012-11-22 00:00:08 -06002697static int rbd_img_request_submit(struct rbd_img_request *img_request)
2698{
Alex Elderbf0d5f502012-11-22 00:00:08 -06002699 struct rbd_obj_request *obj_request;
Alex Elder46faeed2013-04-10 17:47:46 -05002700 struct rbd_obj_request *next_obj_request;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002701
Alex Elder37206ee2013-02-20 17:32:08 -06002702 dout("%s: img %p\n", __func__, img_request);
Alex Elder46faeed2013-04-10 17:47:46 -05002703 for_each_obj_request_safe(img_request, obj_request, next_obj_request) {
Alex Elderbf0d5f502012-11-22 00:00:08 -06002704 int ret;
2705
Alex Elderb454e362013-04-19 15:34:50 -05002706 ret = rbd_img_obj_request_submit(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06002707 if (ret)
2708 return ret;
Alex Elderbf0d5f502012-11-22 00:00:08 -06002709 }
2710
2711 return 0;
2712}
2713
Alex Elder8b3e1a52013-01-24 16:13:36 -06002714static void rbd_img_parent_read_callback(struct rbd_img_request *img_request)
2715{
2716 struct rbd_obj_request *obj_request;
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002717 struct rbd_device *rbd_dev;
2718 u64 obj_end;
Alex Elder02c74fb2013-05-06 17:40:33 -05002719 u64 img_xferred;
2720 int img_result;
Alex Elder8b3e1a52013-01-24 16:13:36 -06002721
2722 rbd_assert(img_request_child_test(img_request));
2723
Alex Elder02c74fb2013-05-06 17:40:33 -05002724 /* First get what we need from the image request and release it */
2725
Alex Elder8b3e1a52013-01-24 16:13:36 -06002726 obj_request = img_request->obj_request;
Alex Elder02c74fb2013-05-06 17:40:33 -05002727 img_xferred = img_request->xferred;
2728 img_result = img_request->result;
2729 rbd_img_request_put(img_request);
2730
2731 /*
2732 * If the overlap has become 0 (most likely because the
2733 * image has been flattened) we need to re-submit the
2734 * original request.
2735 */
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002736 rbd_assert(obj_request);
2737 rbd_assert(obj_request->img_request);
Alex Elder02c74fb2013-05-06 17:40:33 -05002738 rbd_dev = obj_request->img_request->rbd_dev;
2739 if (!rbd_dev->parent_overlap) {
2740 struct ceph_osd_client *osdc;
Alex Elder8b3e1a52013-01-24 16:13:36 -06002741
Alex Elder02c74fb2013-05-06 17:40:33 -05002742 osdc = &rbd_dev->rbd_client->client->osdc;
2743 img_result = rbd_obj_request_submit(osdc, obj_request);
2744 if (!img_result)
2745 return;
2746 }
2747
2748 obj_request->result = img_result;
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002749 if (obj_request->result)
2750 goto out;
2751
2752 /*
2753 * We need to zero anything beyond the parent overlap
2754 * boundary. Since rbd_img_obj_request_read_callback()
2755 * will zero anything beyond the end of a short read, an
2756 * easy way to do this is to pretend the data from the
2757 * parent came up short--ending at the overlap boundary.
2758 */
2759 rbd_assert(obj_request->img_offset < U64_MAX - obj_request->length);
2760 obj_end = obj_request->img_offset + obj_request->length;
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002761 if (obj_end > rbd_dev->parent_overlap) {
2762 u64 xferred = 0;
2763
2764 if (obj_request->img_offset < rbd_dev->parent_overlap)
2765 xferred = rbd_dev->parent_overlap -
2766 obj_request->img_offset;
2767
Alex Elder02c74fb2013-05-06 17:40:33 -05002768 obj_request->xferred = min(img_xferred, xferred);
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002769 } else {
Alex Elder02c74fb2013-05-06 17:40:33 -05002770 obj_request->xferred = img_xferred;
Alex Eldera9e8ba2c2013-04-21 00:32:07 -05002771 }
2772out:
Alex Elder8b3e1a52013-01-24 16:13:36 -06002773 rbd_img_obj_request_read_callback(obj_request);
2774 rbd_obj_request_complete(obj_request);
2775}
2776
2777static void rbd_img_parent_read(struct rbd_obj_request *obj_request)
2778{
Alex Elder8b3e1a52013-01-24 16:13:36 -06002779 struct rbd_img_request *img_request;
2780 int result;
2781
2782 rbd_assert(obj_request_img_data_test(obj_request));
2783 rbd_assert(obj_request->img_request != NULL);
2784 rbd_assert(obj_request->result == (s32) -ENOENT);
Alex Elder5b2ab722013-05-06 17:40:33 -05002785 rbd_assert(obj_request_type_valid(obj_request->type));
Alex Elder8b3e1a52013-01-24 16:13:36 -06002786
Alex Elder8b3e1a52013-01-24 16:13:36 -06002787 /* rbd_read_finish(obj_request, obj_request->length); */
Alex Eldere93f3152013-05-08 22:50:04 -05002788 img_request = rbd_parent_request_create(obj_request,
Alex Elder8b3e1a52013-01-24 16:13:36 -06002789 obj_request->img_offset,
Alex Eldere93f3152013-05-08 22:50:04 -05002790 obj_request->length);
Alex Elder8b3e1a52013-01-24 16:13:36 -06002791 result = -ENOMEM;
2792 if (!img_request)
2793 goto out_err;
2794
Alex Elder5b2ab722013-05-06 17:40:33 -05002795 if (obj_request->type == OBJ_REQUEST_BIO)
2796 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
2797 obj_request->bio_list);
2798 else
2799 result = rbd_img_request_fill(img_request, OBJ_REQUEST_PAGES,
2800 obj_request->pages);
Alex Elder8b3e1a52013-01-24 16:13:36 -06002801 if (result)
2802 goto out_err;
2803
2804 img_request->callback = rbd_img_parent_read_callback;
2805 result = rbd_img_request_submit(img_request);
2806 if (result)
2807 goto out_err;
2808
2809 return;
2810out_err:
2811 if (img_request)
2812 rbd_img_request_put(img_request);
2813 obj_request->result = result;
2814 obj_request->xferred = 0;
2815 obj_request_done_set(obj_request);
2816}
2817
Alex Eldercc4a38bd2013-04-30 00:44:33 -05002818static int rbd_obj_notify_ack(struct rbd_device *rbd_dev, u64 notify_id)
Alex Elderb8d70032012-11-30 17:53:04 -06002819{
2820 struct rbd_obj_request *obj_request;
Alex Elder21692382013-04-05 01:27:12 -05002821 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
Alex Elderb8d70032012-11-30 17:53:04 -06002822 int ret;
2823
2824 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
2825 OBJ_REQUEST_NODATA);
2826 if (!obj_request)
2827 return -ENOMEM;
2828
2829 ret = -ENOMEM;
Alex Elder430c28c2013-04-03 21:32:51 -05002830 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, obj_request);
Alex Elderb8d70032012-11-30 17:53:04 -06002831 if (!obj_request->osd_req)
2832 goto out;
Alex Elder21692382013-04-05 01:27:12 -05002833 obj_request->callback = rbd_obj_request_put;
Alex Elderb8d70032012-11-30 17:53:04 -06002834
Alex Elderc99d2d42013-04-05 01:27:11 -05002835 osd_req_op_watch_init(obj_request->osd_req, 0, CEPH_OSD_OP_NOTIFY_ACK,
Alex Eldercc4a38bd2013-04-30 00:44:33 -05002836 notify_id, 0, 0);
Alex Elder9d4df012013-04-19 15:34:50 -05002837 rbd_osd_req_format_read(obj_request);
Alex Elder430c28c2013-04-03 21:32:51 -05002838
Alex Elderb8d70032012-11-30 17:53:04 -06002839 ret = rbd_obj_request_submit(osdc, obj_request);
Alex Elderb8d70032012-11-30 17:53:04 -06002840out:
Alex Eldercf81b602013-01-17 12:18:46 -06002841 if (ret)
2842 rbd_obj_request_put(obj_request);
Alex Elderb8d70032012-11-30 17:53:04 -06002843
2844 return ret;
2845}
2846
2847static void rbd_watch_cb(u64 ver, u64 notify_id, u8 opcode, void *data)
2848{
2849 struct rbd_device *rbd_dev = (struct rbd_device *)data;
Alex Eldere627db02013-05-06 07:40:30 -05002850 int ret;
Alex Elderb8d70032012-11-30 17:53:04 -06002851
2852 if (!rbd_dev)
2853 return;
2854
Alex Elder37206ee2013-02-20 17:32:08 -06002855 dout("%s: \"%s\" notify_id %llu opcode %u\n", __func__,
Alex Eldercc4a38bd2013-04-30 00:44:33 -05002856 rbd_dev->header_name, (unsigned long long)notify_id,
2857 (unsigned int)opcode);
Alex Eldere627db02013-05-06 07:40:30 -05002858 ret = rbd_dev_refresh(rbd_dev);
2859 if (ret)
2860 rbd_warn(rbd_dev, ": header refresh error (%d)\n", ret);
Alex Elderb8d70032012-11-30 17:53:04 -06002861
Alex Eldercc4a38bd2013-04-30 00:44:33 -05002862 rbd_obj_notify_ack(rbd_dev, notify_id);
Alex Elderb8d70032012-11-30 17:53:04 -06002863}
2864
Alex Elder9969ebc2013-01-18 12:31:10 -06002865/*
2866 * Request sync osd watch/unwatch. The value of "start" determines
2867 * whether a watch request is being initiated or torn down.
2868 */
Alex Elder1f3ef782013-05-06 17:40:33 -05002869static int rbd_dev_header_watch_sync(struct rbd_device *rbd_dev, bool start)
Alex Elder9969ebc2013-01-18 12:31:10 -06002870{
2871 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
2872 struct rbd_obj_request *obj_request;
Alex Elder9969ebc2013-01-18 12:31:10 -06002873 int ret;
2874
2875 rbd_assert(start ^ !!rbd_dev->watch_event);
2876 rbd_assert(start ^ !!rbd_dev->watch_request);
2877
2878 if (start) {
Alex Elder3c663bb2013-02-15 11:42:30 -06002879 ret = ceph_osdc_create_event(osdc, rbd_watch_cb, rbd_dev,
Alex Elder9969ebc2013-01-18 12:31:10 -06002880 &rbd_dev->watch_event);
2881 if (ret < 0)
2882 return ret;
Alex Elder8eb87562013-01-25 17:08:55 -06002883 rbd_assert(rbd_dev->watch_event != NULL);
Alex Elder9969ebc2013-01-18 12:31:10 -06002884 }
2885
2886 ret = -ENOMEM;
2887 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
2888 OBJ_REQUEST_NODATA);
2889 if (!obj_request)
2890 goto out_cancel;
2891
Alex Elder430c28c2013-04-03 21:32:51 -05002892 obj_request->osd_req = rbd_osd_req_create(rbd_dev, true, obj_request);
2893 if (!obj_request->osd_req)
2894 goto out_cancel;
2895
Alex Elder8eb87562013-01-25 17:08:55 -06002896 if (start)
Alex Elder975241a2013-01-25 17:08:55 -06002897 ceph_osdc_set_request_linger(osdc, obj_request->osd_req);
Alex Elder8eb87562013-01-25 17:08:55 -06002898 else
Alex Elder6977c3f2013-01-25 17:08:55 -06002899 ceph_osdc_unregister_linger_request(osdc,
Alex Elder975241a2013-01-25 17:08:55 -06002900 rbd_dev->watch_request->osd_req);
Alex Elder21692382013-04-05 01:27:12 -05002901
2902 osd_req_op_watch_init(obj_request->osd_req, 0, CEPH_OSD_OP_WATCH,
Alex Elder1f3ef782013-05-06 17:40:33 -05002903 rbd_dev->watch_event->cookie, 0, start ? 1 : 0);
Alex Elder9d4df012013-04-19 15:34:50 -05002904 rbd_osd_req_format_write(obj_request);
Alex Elder21692382013-04-05 01:27:12 -05002905
Alex Elder9969ebc2013-01-18 12:31:10 -06002906 ret = rbd_obj_request_submit(osdc, obj_request);
2907 if (ret)
2908 goto out_cancel;
2909 ret = rbd_obj_request_wait(obj_request);
2910 if (ret)
2911 goto out_cancel;
Alex Elder9969ebc2013-01-18 12:31:10 -06002912 ret = obj_request->result;
2913 if (ret)
2914 goto out_cancel;
2915
Alex Elder8eb87562013-01-25 17:08:55 -06002916 /*
2917 * A watch request is set to linger, so the underlying osd
2918 * request won't go away until we unregister it. We retain
2919 * a pointer to the object request during that time (in
2920 * rbd_dev->watch_request), so we'll keep a reference to
2921 * it. We'll drop that reference (below) after we've
2922 * unregistered it.
2923 */
2924 if (start) {
2925 rbd_dev->watch_request = obj_request;
2926
2927 return 0;
2928 }
2929
2930 /* We have successfully torn down the watch request */
2931
2932 rbd_obj_request_put(rbd_dev->watch_request);
2933 rbd_dev->watch_request = NULL;
Alex Elder9969ebc2013-01-18 12:31:10 -06002934out_cancel:
2935 /* Cancel the event if we're tearing down, or on error */
2936 ceph_osdc_cancel_event(rbd_dev->watch_event);
2937 rbd_dev->watch_event = NULL;
Alex Elder9969ebc2013-01-18 12:31:10 -06002938 if (obj_request)
2939 rbd_obj_request_put(obj_request);
2940
2941 return ret;
2942}
2943
Alex Elder36be9a72013-01-19 00:30:28 -06002944/*
Alex Elderf40eb342013-04-25 15:09:42 -05002945 * Synchronous osd object method call. Returns the number of bytes
2946 * returned in the outbound buffer, or a negative error code.
Alex Elder36be9a72013-01-19 00:30:28 -06002947 */
2948static int rbd_obj_method_sync(struct rbd_device *rbd_dev,
2949 const char *object_name,
2950 const char *class_name,
2951 const char *method_name,
Alex Elder41579762013-04-21 12:14:45 -05002952 const void *outbound,
Alex Elder36be9a72013-01-19 00:30:28 -06002953 size_t outbound_size,
Alex Elder41579762013-04-21 12:14:45 -05002954 void *inbound,
Alex Eldere2a58ee2013-04-30 00:44:33 -05002955 size_t inbound_size)
Alex Elder36be9a72013-01-19 00:30:28 -06002956{
Alex Elder21692382013-04-05 01:27:12 -05002957 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
Alex Elder36be9a72013-01-19 00:30:28 -06002958 struct rbd_obj_request *obj_request;
Alex Elder36be9a72013-01-19 00:30:28 -06002959 struct page **pages;
2960 u32 page_count;
2961 int ret;
2962
2963 /*
Alex Elder6010a452013-04-05 01:27:11 -05002964 * Method calls are ultimately read operations. The result
2965 * should placed into the inbound buffer provided. They
2966 * also supply outbound data--parameters for the object
2967 * method. Currently if this is present it will be a
2968 * snapshot id.
Alex Elder36be9a72013-01-19 00:30:28 -06002969 */
Alex Elder57385b52013-04-21 12:14:45 -05002970 page_count = (u32)calc_pages_for(0, inbound_size);
Alex Elder36be9a72013-01-19 00:30:28 -06002971 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2972 if (IS_ERR(pages))
2973 return PTR_ERR(pages);
2974
2975 ret = -ENOMEM;
Alex Elder6010a452013-04-05 01:27:11 -05002976 obj_request = rbd_obj_request_create(object_name, 0, inbound_size,
Alex Elder36be9a72013-01-19 00:30:28 -06002977 OBJ_REQUEST_PAGES);
2978 if (!obj_request)
2979 goto out;
2980
2981 obj_request->pages = pages;
2982 obj_request->page_count = page_count;
2983
Alex Elder430c28c2013-04-03 21:32:51 -05002984 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, obj_request);
Alex Elder36be9a72013-01-19 00:30:28 -06002985 if (!obj_request->osd_req)
2986 goto out;
2987
Alex Elderc99d2d42013-04-05 01:27:11 -05002988 osd_req_op_cls_init(obj_request->osd_req, 0, CEPH_OSD_OP_CALL,
Alex Elder04017e22013-04-05 14:46:02 -05002989 class_name, method_name);
2990 if (outbound_size) {
2991 struct ceph_pagelist *pagelist;
2992
2993 pagelist = kmalloc(sizeof (*pagelist), GFP_NOFS);
2994 if (!pagelist)
2995 goto out;
2996
2997 ceph_pagelist_init(pagelist);
2998 ceph_pagelist_append(pagelist, outbound, outbound_size);
2999 osd_req_op_cls_request_data_pagelist(obj_request->osd_req, 0,
3000 pagelist);
3001 }
Alex Eldera4ce40a2013-04-05 01:27:12 -05003002 osd_req_op_cls_response_data_pages(obj_request->osd_req, 0,
3003 obj_request->pages, inbound_size,
Alex Elder44cd1882013-04-05 01:27:12 -05003004 0, false, false);
Alex Elder9d4df012013-04-19 15:34:50 -05003005 rbd_osd_req_format_read(obj_request);
Alex Elder430c28c2013-04-03 21:32:51 -05003006
Alex Elder36be9a72013-01-19 00:30:28 -06003007 ret = rbd_obj_request_submit(osdc, obj_request);
3008 if (ret)
3009 goto out;
3010 ret = rbd_obj_request_wait(obj_request);
3011 if (ret)
3012 goto out;
3013
3014 ret = obj_request->result;
3015 if (ret < 0)
3016 goto out;
Alex Elder57385b52013-04-21 12:14:45 -05003017
3018 rbd_assert(obj_request->xferred < (u64)INT_MAX);
3019 ret = (int)obj_request->xferred;
Alex Elder903bb322013-02-06 13:11:38 -06003020 ceph_copy_from_page_vector(pages, inbound, 0, obj_request->xferred);
Alex Elder36be9a72013-01-19 00:30:28 -06003021out:
3022 if (obj_request)
3023 rbd_obj_request_put(obj_request);
3024 else
3025 ceph_release_page_vector(pages, page_count);
3026
3027 return ret;
3028}
3029
Alex Elderbf0d5f502012-11-22 00:00:08 -06003030static void rbd_request_fn(struct request_queue *q)
Alex Eldercc344fa2013-02-19 12:25:56 -06003031 __releases(q->queue_lock) __acquires(q->queue_lock)
Alex Elderbf0d5f502012-11-22 00:00:08 -06003032{
3033 struct rbd_device *rbd_dev = q->queuedata;
3034 bool read_only = rbd_dev->mapping.read_only;
3035 struct request *rq;
3036 int result;
3037
3038 while ((rq = blk_fetch_request(q))) {
3039 bool write_request = rq_data_dir(rq) == WRITE;
3040 struct rbd_img_request *img_request;
3041 u64 offset;
3042 u64 length;
3043
3044 /* Ignore any non-FS requests that filter through. */
3045
3046 if (rq->cmd_type != REQ_TYPE_FS) {
Alex Elder4dda41d2013-02-20 21:59:33 -06003047 dout("%s: non-fs request type %d\n", __func__,
3048 (int) rq->cmd_type);
3049 __blk_end_request_all(rq, 0);
3050 continue;
3051 }
3052
3053 /* Ignore/skip any zero-length requests */
3054
3055 offset = (u64) blk_rq_pos(rq) << SECTOR_SHIFT;
3056 length = (u64) blk_rq_bytes(rq);
3057
3058 if (!length) {
3059 dout("%s: zero-length request\n", __func__);
Alex Elderbf0d5f502012-11-22 00:00:08 -06003060 __blk_end_request_all(rq, 0);
3061 continue;
3062 }
3063
3064 spin_unlock_irq(q->queue_lock);
3065
3066 /* Disallow writes to a read-only device */
3067
3068 if (write_request) {
3069 result = -EROFS;
3070 if (read_only)
3071 goto end_request;
3072 rbd_assert(rbd_dev->spec->snap_id == CEPH_NOSNAP);
3073 }
3074
Alex Elder6d292902013-01-14 12:43:31 -06003075 /*
3076 * Quit early if the mapped snapshot no longer
3077 * exists. It's still possible the snapshot will
3078 * have disappeared by the time our request arrives
3079 * at the osd, but there's no sense in sending it if
3080 * we already know.
3081 */
3082 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags)) {
Alex Elderbf0d5f502012-11-22 00:00:08 -06003083 dout("request for non-existent snapshot");
3084 rbd_assert(rbd_dev->spec->snap_id != CEPH_NOSNAP);
3085 result = -ENXIO;
3086 goto end_request;
3087 }
3088
Alex Elderbf0d5f502012-11-22 00:00:08 -06003089 result = -EINVAL;
Alex Elderc0cd10db2013-04-26 09:43:47 -05003090 if (offset && length > U64_MAX - offset + 1) {
3091 rbd_warn(rbd_dev, "bad request range (%llu~%llu)\n",
3092 offset, length);
Alex Elderbf0d5f502012-11-22 00:00:08 -06003093 goto end_request; /* Shouldn't happen */
Alex Elderc0cd10db2013-04-26 09:43:47 -05003094 }
Alex Elderbf0d5f502012-11-22 00:00:08 -06003095
Alex Elder00a653e2013-05-06 07:40:30 -05003096 result = -EIO;
3097 if (offset + length > rbd_dev->mapping.size) {
3098 rbd_warn(rbd_dev, "beyond EOD (%llu~%llu > %llu)\n",
3099 offset, length, rbd_dev->mapping.size);
3100 goto end_request;
3101 }
3102
Alex Elderbf0d5f502012-11-22 00:00:08 -06003103 result = -ENOMEM;
3104 img_request = rbd_img_request_create(rbd_dev, offset, length,
Alex Eldere93f3152013-05-08 22:50:04 -05003105 write_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06003106 if (!img_request)
3107 goto end_request;
3108
3109 img_request->rq = rq;
3110
Alex Elderf1a47392013-04-19 15:34:50 -05003111 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
3112 rq->bio);
Alex Elderbf0d5f502012-11-22 00:00:08 -06003113 if (!result)
3114 result = rbd_img_request_submit(img_request);
3115 if (result)
3116 rbd_img_request_put(img_request);
3117end_request:
3118 spin_lock_irq(q->queue_lock);
3119 if (result < 0) {
Alex Elder7da22d22013-01-24 16:13:36 -06003120 rbd_warn(rbd_dev, "%s %llx at %llx result %d\n",
3121 write_request ? "write" : "read",
3122 length, offset, result);
3123
Alex Elderbf0d5f502012-11-22 00:00:08 -06003124 __blk_end_request_all(rq, result);
3125 }
3126 }
3127}
3128
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003129/*
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003130 * a queue callback. Makes sure that we don't create a bio that spans across
3131 * multiple osd objects. One exception would be with a single page bios,
Alex Elderf7760da2012-10-20 22:17:27 -05003132 * which we handle later at bio_chain_clone_range()
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003133 */
3134static int rbd_merge_bvec(struct request_queue *q, struct bvec_merge_data *bmd,
3135 struct bio_vec *bvec)
3136{
3137 struct rbd_device *rbd_dev = q->queuedata;
Alex Eldere5cfeed22012-10-20 22:17:27 -05003138 sector_t sector_offset;
3139 sector_t sectors_per_obj;
3140 sector_t obj_sector_offset;
3141 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003142
Alex Eldere5cfeed22012-10-20 22:17:27 -05003143 /*
3144 * Find how far into its rbd object the partition-relative
3145 * bio start sector is to offset relative to the enclosing
3146 * device.
3147 */
3148 sector_offset = get_start_sect(bmd->bi_bdev) + bmd->bi_sector;
3149 sectors_per_obj = 1 << (rbd_dev->header.obj_order - SECTOR_SHIFT);
3150 obj_sector_offset = sector_offset & (sectors_per_obj - 1);
Alex Elder593a9e72012-02-07 12:03:37 -06003151
Alex Eldere5cfeed22012-10-20 22:17:27 -05003152 /*
3153 * Compute the number of bytes from that offset to the end
3154 * of the object. Account for what's already used by the bio.
3155 */
3156 ret = (int) (sectors_per_obj - obj_sector_offset) << SECTOR_SHIFT;
3157 if (ret > bmd->bi_size)
3158 ret -= bmd->bi_size;
3159 else
3160 ret = 0;
3161
3162 /*
3163 * Don't send back more than was asked for. And if the bio
3164 * was empty, let the whole thing through because: "Note
3165 * that a block device *must* allow a single page to be
3166 * added to an empty bio."
3167 */
3168 rbd_assert(bvec->bv_len <= PAGE_SIZE);
3169 if (ret > (int) bvec->bv_len || !bmd->bi_size)
3170 ret = (int) bvec->bv_len;
3171
3172 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003173}
3174
3175static void rbd_free_disk(struct rbd_device *rbd_dev)
3176{
3177 struct gendisk *disk = rbd_dev->disk;
3178
3179 if (!disk)
3180 return;
3181
Alex Eldera0cab922013-04-25 23:15:08 -05003182 rbd_dev->disk = NULL;
3183 if (disk->flags & GENHD_FL_UP) {
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003184 del_gendisk(disk);
Alex Eldera0cab922013-04-25 23:15:08 -05003185 if (disk->queue)
3186 blk_cleanup_queue(disk->queue);
3187 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003188 put_disk(disk);
3189}
3190
Alex Elder788e2df2013-01-17 12:25:27 -06003191static int rbd_obj_read_sync(struct rbd_device *rbd_dev,
3192 const char *object_name,
Alex Elder7097f8d2013-04-30 00:44:33 -05003193 u64 offset, u64 length, void *buf)
Alex Elder788e2df2013-01-17 12:25:27 -06003194
3195{
Alex Elder21692382013-04-05 01:27:12 -05003196 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
Alex Elder788e2df2013-01-17 12:25:27 -06003197 struct rbd_obj_request *obj_request;
Alex Elder788e2df2013-01-17 12:25:27 -06003198 struct page **pages = NULL;
3199 u32 page_count;
Alex Elder1ceae7e2013-02-06 13:11:38 -06003200 size_t size;
Alex Elder788e2df2013-01-17 12:25:27 -06003201 int ret;
3202
3203 page_count = (u32) calc_pages_for(offset, length);
3204 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
3205 if (IS_ERR(pages))
3206 ret = PTR_ERR(pages);
3207
3208 ret = -ENOMEM;
3209 obj_request = rbd_obj_request_create(object_name, offset, length,
Alex Elder36be9a72013-01-19 00:30:28 -06003210 OBJ_REQUEST_PAGES);
Alex Elder788e2df2013-01-17 12:25:27 -06003211 if (!obj_request)
3212 goto out;
3213
3214 obj_request->pages = pages;
3215 obj_request->page_count = page_count;
3216
Alex Elder430c28c2013-04-03 21:32:51 -05003217 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, obj_request);
Alex Elder788e2df2013-01-17 12:25:27 -06003218 if (!obj_request->osd_req)
3219 goto out;
3220
Alex Elderc99d2d42013-04-05 01:27:11 -05003221 osd_req_op_extent_init(obj_request->osd_req, 0, CEPH_OSD_OP_READ,
3222 offset, length, 0, 0);
Alex Elder406e2c92013-04-15 14:50:36 -05003223 osd_req_op_extent_osd_data_pages(obj_request->osd_req, 0,
Alex Eldera4ce40a2013-04-05 01:27:12 -05003224 obj_request->pages,
Alex Elder44cd1882013-04-05 01:27:12 -05003225 obj_request->length,
3226 obj_request->offset & ~PAGE_MASK,
3227 false, false);
Alex Elder9d4df012013-04-19 15:34:50 -05003228 rbd_osd_req_format_read(obj_request);
Alex Elder430c28c2013-04-03 21:32:51 -05003229
Alex Elder788e2df2013-01-17 12:25:27 -06003230 ret = rbd_obj_request_submit(osdc, obj_request);
3231 if (ret)
3232 goto out;
3233 ret = rbd_obj_request_wait(obj_request);
3234 if (ret)
3235 goto out;
3236
3237 ret = obj_request->result;
3238 if (ret < 0)
3239 goto out;
Alex Elder1ceae7e2013-02-06 13:11:38 -06003240
3241 rbd_assert(obj_request->xferred <= (u64) SIZE_MAX);
3242 size = (size_t) obj_request->xferred;
Alex Elder903bb322013-02-06 13:11:38 -06003243 ceph_copy_from_page_vector(pages, buf, 0, size);
Alex Elder7097f8d2013-04-30 00:44:33 -05003244 rbd_assert(size <= (size_t)INT_MAX);
3245 ret = (int)size;
Alex Elder788e2df2013-01-17 12:25:27 -06003246out:
3247 if (obj_request)
3248 rbd_obj_request_put(obj_request);
3249 else
3250 ceph_release_page_vector(pages, page_count);
3251
3252 return ret;
3253}
3254
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003255/*
Alex Elder662518b2013-05-06 09:51:29 -05003256 * Read the complete header for the given rbd device. On successful
3257 * return, the rbd_dev->header field will contain up-to-date
3258 * information about the image.
Alex Elder4156d992012-08-02 11:29:46 -05003259 */
Alex Elder99a41eb2013-05-06 09:51:30 -05003260static int rbd_dev_v1_header_info(struct rbd_device *rbd_dev)
Alex Elder4156d992012-08-02 11:29:46 -05003261{
3262 struct rbd_image_header_ondisk *ondisk = NULL;
3263 u32 snap_count = 0;
3264 u64 names_size = 0;
3265 u32 want_count;
3266 int ret;
3267
3268 /*
3269 * The complete header will include an array of its 64-bit
3270 * snapshot ids, followed by the names of those snapshots as
3271 * a contiguous block of NUL-terminated strings. Note that
3272 * the number of snapshots could change by the time we read
3273 * it in, in which case we re-read it.
3274 */
3275 do {
3276 size_t size;
3277
3278 kfree(ondisk);
3279
3280 size = sizeof (*ondisk);
3281 size += snap_count * sizeof (struct rbd_image_snap_ondisk);
3282 size += names_size;
3283 ondisk = kmalloc(size, GFP_KERNEL);
3284 if (!ondisk)
Alex Elder662518b2013-05-06 09:51:29 -05003285 return -ENOMEM;
Alex Elder4156d992012-08-02 11:29:46 -05003286
Alex Elder788e2df2013-01-17 12:25:27 -06003287 ret = rbd_obj_read_sync(rbd_dev, rbd_dev->header_name,
Alex Elder7097f8d2013-04-30 00:44:33 -05003288 0, size, ondisk);
Alex Elder4156d992012-08-02 11:29:46 -05003289 if (ret < 0)
Alex Elder662518b2013-05-06 09:51:29 -05003290 goto out;
Alex Elderc0cd10db2013-04-26 09:43:47 -05003291 if ((size_t)ret < size) {
Alex Elder4156d992012-08-02 11:29:46 -05003292 ret = -ENXIO;
Alex Elder06ecc6c2012-11-01 10:17:15 -05003293 rbd_warn(rbd_dev, "short header read (want %zd got %d)",
3294 size, ret);
Alex Elder662518b2013-05-06 09:51:29 -05003295 goto out;
Alex Elder4156d992012-08-02 11:29:46 -05003296 }
3297 if (!rbd_dev_ondisk_valid(ondisk)) {
3298 ret = -ENXIO;
Alex Elder06ecc6c2012-11-01 10:17:15 -05003299 rbd_warn(rbd_dev, "invalid header");
Alex Elder662518b2013-05-06 09:51:29 -05003300 goto out;
Alex Elder4156d992012-08-02 11:29:46 -05003301 }
3302
3303 names_size = le64_to_cpu(ondisk->snap_names_len);
3304 want_count = snap_count;
3305 snap_count = le32_to_cpu(ondisk->snap_count);
3306 } while (snap_count != want_count);
3307
Alex Elder662518b2013-05-06 09:51:29 -05003308 ret = rbd_header_from_disk(rbd_dev, ondisk);
3309out:
Alex Elder4156d992012-08-02 11:29:46 -05003310 kfree(ondisk);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003311
Alex Elder4156d992012-08-02 11:29:46 -05003312 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003313}
3314
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003315/*
Alex Elder15228ed2013-05-01 12:43:03 -05003316 * Clear the rbd device's EXISTS flag if the snapshot it's mapped to
3317 * has disappeared from the (just updated) snapshot context.
3318 */
3319static void rbd_exists_validate(struct rbd_device *rbd_dev)
3320{
3321 u64 snap_id;
3322
3323 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags))
3324 return;
3325
3326 snap_id = rbd_dev->spec->snap_id;
3327 if (snap_id == CEPH_NOSNAP)
3328 return;
3329
3330 if (rbd_dev_snap_index(rbd_dev, snap_id) == BAD_SNAP_INDEX)
3331 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
3332}
3333
Alex Eldercc4a38bd2013-04-30 00:44:33 -05003334static int rbd_dev_refresh(struct rbd_device *rbd_dev)
Alex Elder1fe5e992012-07-25 09:32:41 -05003335{
Alex Eldere627db02013-05-06 07:40:30 -05003336 u64 mapping_size;
Alex Elder1fe5e992012-07-25 09:32:41 -05003337 int ret;
3338
Alex Elder117973f2012-08-31 17:29:55 -05003339 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
Alex Eldere627db02013-05-06 07:40:30 -05003340 mapping_size = rbd_dev->mapping.size;
Alex Elder1fe5e992012-07-25 09:32:41 -05003341 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Alex Elder117973f2012-08-31 17:29:55 -05003342 if (rbd_dev->image_format == 1)
Alex Elder99a41eb2013-05-06 09:51:30 -05003343 ret = rbd_dev_v1_header_info(rbd_dev);
Alex Elder117973f2012-08-31 17:29:55 -05003344 else
Alex Elder2df3fac2013-05-06 09:51:30 -05003345 ret = rbd_dev_v2_header_info(rbd_dev);
Alex Elder15228ed2013-05-01 12:43:03 -05003346
3347 /* If it's a mapped snapshot, validate its EXISTS flag */
3348
3349 rbd_exists_validate(rbd_dev);
Alex Elder1fe5e992012-07-25 09:32:41 -05003350 mutex_unlock(&ctl_mutex);
Alex Elder00a653e2013-05-06 07:40:30 -05003351 if (mapping_size != rbd_dev->mapping.size) {
3352 sector_t size;
3353
3354 size = (sector_t)rbd_dev->mapping.size / SECTOR_SIZE;
3355 dout("setting size to %llu sectors", (unsigned long long)size);
3356 set_capacity(rbd_dev->disk, size);
Alex Eldera3fbe5d2013-04-30 00:44:32 -05003357 revalidate_disk(rbd_dev->disk);
Alex Elder00a653e2013-05-06 07:40:30 -05003358 }
Alex Elder1fe5e992012-07-25 09:32:41 -05003359
3360 return ret;
3361}
3362
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003363static int rbd_init_disk(struct rbd_device *rbd_dev)
3364{
3365 struct gendisk *disk;
3366 struct request_queue *q;
Alex Elder593a9e72012-02-07 12:03:37 -06003367 u64 segment_size;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003368
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003369 /* create gendisk info */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003370 disk = alloc_disk(RBD_MINORS_PER_MAJOR);
3371 if (!disk)
Alex Elder1fcdb8a2012-08-29 17:11:06 -05003372 return -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003373
Alex Elderf0f8cef2012-01-29 13:57:44 -06003374 snprintf(disk->disk_name, sizeof(disk->disk_name), RBD_DRV_NAME "%d",
Alex Elderde71a292012-07-03 16:01:19 -05003375 rbd_dev->dev_id);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003376 disk->major = rbd_dev->major;
3377 disk->first_minor = 0;
3378 disk->fops = &rbd_bd_ops;
3379 disk->private_data = rbd_dev;
3380
Alex Elderbf0d5f502012-11-22 00:00:08 -06003381 q = blk_init_queue(rbd_request_fn, &rbd_dev->lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003382 if (!q)
3383 goto out_disk;
Josh Durgin029bcbd2011-07-22 11:35:23 -07003384
Alex Elder593a9e72012-02-07 12:03:37 -06003385 /* We use the default size, but let's be explicit about it. */
3386 blk_queue_physical_block_size(q, SECTOR_SIZE);
3387
Josh Durgin029bcbd2011-07-22 11:35:23 -07003388 /* set io sizes to object size */
Alex Elder593a9e72012-02-07 12:03:37 -06003389 segment_size = rbd_obj_bytes(&rbd_dev->header);
3390 blk_queue_max_hw_sectors(q, segment_size / SECTOR_SIZE);
3391 blk_queue_max_segment_size(q, segment_size);
3392 blk_queue_io_min(q, segment_size);
3393 blk_queue_io_opt(q, segment_size);
Josh Durgin029bcbd2011-07-22 11:35:23 -07003394
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003395 blk_queue_merge_bvec(q, rbd_merge_bvec);
3396 disk->queue = q;
3397
3398 q->queuedata = rbd_dev;
3399
3400 rbd_dev->disk = disk;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003401
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003402 return 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003403out_disk:
3404 put_disk(disk);
Alex Elder1fcdb8a2012-08-29 17:11:06 -05003405
3406 return -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003407}
3408
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003409/*
3410 sysfs
3411*/
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003412
Alex Elder593a9e72012-02-07 12:03:37 -06003413static struct rbd_device *dev_to_rbd_dev(struct device *dev)
3414{
3415 return container_of(dev, struct rbd_device, dev);
3416}
3417
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003418static ssize_t rbd_size_show(struct device *dev,
3419 struct device_attribute *attr, char *buf)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003420{
Alex Elder593a9e72012-02-07 12:03:37 -06003421 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003422
Alex Elderfc71d832013-04-26 15:44:36 -05003423 return sprintf(buf, "%llu\n",
3424 (unsigned long long)rbd_dev->mapping.size);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003425}
3426
Alex Elder34b13182012-07-13 20:35:12 -05003427/*
3428 * Note this shows the features for whatever's mapped, which is not
3429 * necessarily the base image.
3430 */
3431static ssize_t rbd_features_show(struct device *dev,
3432 struct device_attribute *attr, char *buf)
3433{
3434 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3435
3436 return sprintf(buf, "0x%016llx\n",
Alex Elderfc71d832013-04-26 15:44:36 -05003437 (unsigned long long)rbd_dev->mapping.features);
Alex Elder34b13182012-07-13 20:35:12 -05003438}
3439
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003440static ssize_t rbd_major_show(struct device *dev,
3441 struct device_attribute *attr, char *buf)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003442{
Alex Elder593a9e72012-02-07 12:03:37 -06003443 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003444
Alex Elderfc71d832013-04-26 15:44:36 -05003445 if (rbd_dev->major)
3446 return sprintf(buf, "%d\n", rbd_dev->major);
3447
3448 return sprintf(buf, "(none)\n");
3449
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003450}
3451
3452static ssize_t rbd_client_id_show(struct device *dev,
3453 struct device_attribute *attr, char *buf)
3454{
Alex Elder593a9e72012-02-07 12:03:37 -06003455 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003456
Alex Elder1dbb4392012-01-24 10:08:37 -06003457 return sprintf(buf, "client%lld\n",
3458 ceph_client_id(rbd_dev->rbd_client->client));
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003459}
3460
3461static ssize_t rbd_pool_show(struct device *dev,
3462 struct device_attribute *attr, char *buf)
3463{
Alex Elder593a9e72012-02-07 12:03:37 -06003464 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003465
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003466 return sprintf(buf, "%s\n", rbd_dev->spec->pool_name);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003467}
3468
Alex Elder9bb2f332012-07-12 10:46:35 -05003469static ssize_t rbd_pool_id_show(struct device *dev,
3470 struct device_attribute *attr, char *buf)
3471{
3472 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3473
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003474 return sprintf(buf, "%llu\n",
Alex Elderfc71d832013-04-26 15:44:36 -05003475 (unsigned long long) rbd_dev->spec->pool_id);
Alex Elder9bb2f332012-07-12 10:46:35 -05003476}
3477
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003478static ssize_t rbd_name_show(struct device *dev,
3479 struct device_attribute *attr, char *buf)
3480{
Alex Elder593a9e72012-02-07 12:03:37 -06003481 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003482
Alex Eldera92ffdf2012-10-30 19:40:33 -05003483 if (rbd_dev->spec->image_name)
3484 return sprintf(buf, "%s\n", rbd_dev->spec->image_name);
3485
3486 return sprintf(buf, "(unknown)\n");
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003487}
3488
Alex Elder589d30e2012-07-10 20:30:11 -05003489static ssize_t rbd_image_id_show(struct device *dev,
3490 struct device_attribute *attr, char *buf)
3491{
3492 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3493
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003494 return sprintf(buf, "%s\n", rbd_dev->spec->image_id);
Alex Elder589d30e2012-07-10 20:30:11 -05003495}
3496
Alex Elder34b13182012-07-13 20:35:12 -05003497/*
3498 * Shows the name of the currently-mapped snapshot (or
3499 * RBD_SNAP_HEAD_NAME for the base image).
3500 */
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003501static ssize_t rbd_snap_show(struct device *dev,
3502 struct device_attribute *attr,
3503 char *buf)
3504{
Alex Elder593a9e72012-02-07 12:03:37 -06003505 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003506
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003507 return sprintf(buf, "%s\n", rbd_dev->spec->snap_name);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003508}
3509
Alex Elder86b00e02012-10-25 23:34:42 -05003510/*
3511 * For an rbd v2 image, shows the pool id, image id, and snapshot id
3512 * for the parent image. If there is no parent, simply shows
3513 * "(no parent image)".
3514 */
3515static ssize_t rbd_parent_show(struct device *dev,
3516 struct device_attribute *attr,
3517 char *buf)
3518{
3519 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3520 struct rbd_spec *spec = rbd_dev->parent_spec;
3521 int count;
3522 char *bufp = buf;
3523
3524 if (!spec)
3525 return sprintf(buf, "(no parent image)\n");
3526
3527 count = sprintf(bufp, "pool_id %llu\npool_name %s\n",
3528 (unsigned long long) spec->pool_id, spec->pool_name);
3529 if (count < 0)
3530 return count;
3531 bufp += count;
3532
3533 count = sprintf(bufp, "image_id %s\nimage_name %s\n", spec->image_id,
3534 spec->image_name ? spec->image_name : "(unknown)");
3535 if (count < 0)
3536 return count;
3537 bufp += count;
3538
3539 count = sprintf(bufp, "snap_id %llu\nsnap_name %s\n",
3540 (unsigned long long) spec->snap_id, spec->snap_name);
3541 if (count < 0)
3542 return count;
3543 bufp += count;
3544
3545 count = sprintf(bufp, "overlap %llu\n", rbd_dev->parent_overlap);
3546 if (count < 0)
3547 return count;
3548 bufp += count;
3549
3550 return (ssize_t) (bufp - buf);
3551}
3552
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003553static ssize_t rbd_image_refresh(struct device *dev,
3554 struct device_attribute *attr,
3555 const char *buf,
3556 size_t size)
3557{
Alex Elder593a9e72012-02-07 12:03:37 -06003558 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Alex Elderb8136232012-07-25 09:32:41 -05003559 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003560
Alex Eldercc4a38bd2013-04-30 00:44:33 -05003561 ret = rbd_dev_refresh(rbd_dev);
Alex Eldere627db02013-05-06 07:40:30 -05003562 if (ret)
3563 rbd_warn(rbd_dev, ": manual header refresh error (%d)\n", ret);
Alex Elderb8136232012-07-25 09:32:41 -05003564
3565 return ret < 0 ? ret : size;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003566}
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003567
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003568static DEVICE_ATTR(size, S_IRUGO, rbd_size_show, NULL);
Alex Elder34b13182012-07-13 20:35:12 -05003569static DEVICE_ATTR(features, S_IRUGO, rbd_features_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003570static DEVICE_ATTR(major, S_IRUGO, rbd_major_show, NULL);
3571static DEVICE_ATTR(client_id, S_IRUGO, rbd_client_id_show, NULL);
3572static DEVICE_ATTR(pool, S_IRUGO, rbd_pool_show, NULL);
Alex Elder9bb2f332012-07-12 10:46:35 -05003573static DEVICE_ATTR(pool_id, S_IRUGO, rbd_pool_id_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003574static DEVICE_ATTR(name, S_IRUGO, rbd_name_show, NULL);
Alex Elder589d30e2012-07-10 20:30:11 -05003575static DEVICE_ATTR(image_id, S_IRUGO, rbd_image_id_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003576static DEVICE_ATTR(refresh, S_IWUSR, NULL, rbd_image_refresh);
3577static DEVICE_ATTR(current_snap, S_IRUGO, rbd_snap_show, NULL);
Alex Elder86b00e02012-10-25 23:34:42 -05003578static DEVICE_ATTR(parent, S_IRUGO, rbd_parent_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003579
3580static struct attribute *rbd_attrs[] = {
3581 &dev_attr_size.attr,
Alex Elder34b13182012-07-13 20:35:12 -05003582 &dev_attr_features.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003583 &dev_attr_major.attr,
3584 &dev_attr_client_id.attr,
3585 &dev_attr_pool.attr,
Alex Elder9bb2f332012-07-12 10:46:35 -05003586 &dev_attr_pool_id.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003587 &dev_attr_name.attr,
Alex Elder589d30e2012-07-10 20:30:11 -05003588 &dev_attr_image_id.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003589 &dev_attr_current_snap.attr,
Alex Elder86b00e02012-10-25 23:34:42 -05003590 &dev_attr_parent.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003591 &dev_attr_refresh.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003592 NULL
3593};
3594
3595static struct attribute_group rbd_attr_group = {
3596 .attrs = rbd_attrs,
3597};
3598
3599static const struct attribute_group *rbd_attr_groups[] = {
3600 &rbd_attr_group,
3601 NULL
3602};
3603
3604static void rbd_sysfs_dev_release(struct device *dev)
3605{
3606}
3607
3608static struct device_type rbd_device_type = {
3609 .name = "rbd",
3610 .groups = rbd_attr_groups,
3611 .release = rbd_sysfs_dev_release,
3612};
3613
Alex Elder8b8fb992012-10-26 17:25:24 -05003614static struct rbd_spec *rbd_spec_get(struct rbd_spec *spec)
3615{
3616 kref_get(&spec->kref);
3617
3618 return spec;
3619}
3620
3621static void rbd_spec_free(struct kref *kref);
3622static void rbd_spec_put(struct rbd_spec *spec)
3623{
3624 if (spec)
3625 kref_put(&spec->kref, rbd_spec_free);
3626}
3627
3628static struct rbd_spec *rbd_spec_alloc(void)
3629{
3630 struct rbd_spec *spec;
3631
3632 spec = kzalloc(sizeof (*spec), GFP_KERNEL);
3633 if (!spec)
3634 return NULL;
3635 kref_init(&spec->kref);
3636
Alex Elder8b8fb992012-10-26 17:25:24 -05003637 return spec;
3638}
3639
3640static void rbd_spec_free(struct kref *kref)
3641{
3642 struct rbd_spec *spec = container_of(kref, struct rbd_spec, kref);
3643
3644 kfree(spec->pool_name);
3645 kfree(spec->image_id);
3646 kfree(spec->image_name);
3647 kfree(spec->snap_name);
3648 kfree(spec);
3649}
3650
Alex Eldercc344fa2013-02-19 12:25:56 -06003651static struct rbd_device *rbd_dev_create(struct rbd_client *rbdc,
Alex Elderc53d5892012-10-25 23:34:42 -05003652 struct rbd_spec *spec)
3653{
3654 struct rbd_device *rbd_dev;
3655
3656 rbd_dev = kzalloc(sizeof (*rbd_dev), GFP_KERNEL);
3657 if (!rbd_dev)
3658 return NULL;
3659
3660 spin_lock_init(&rbd_dev->lock);
Alex Elder6d292902013-01-14 12:43:31 -06003661 rbd_dev->flags = 0;
Alex Eldera2acd002013-05-08 22:50:04 -05003662 atomic_set(&rbd_dev->parent_ref, 0);
Alex Elderc53d5892012-10-25 23:34:42 -05003663 INIT_LIST_HEAD(&rbd_dev->node);
Alex Elderc53d5892012-10-25 23:34:42 -05003664 init_rwsem(&rbd_dev->header_rwsem);
3665
3666 rbd_dev->spec = spec;
3667 rbd_dev->rbd_client = rbdc;
3668
Alex Elder0903e872012-11-14 12:25:19 -06003669 /* Initialize the layout used for all rbd requests */
3670
3671 rbd_dev->layout.fl_stripe_unit = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
3672 rbd_dev->layout.fl_stripe_count = cpu_to_le32(1);
3673 rbd_dev->layout.fl_object_size = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
3674 rbd_dev->layout.fl_pg_pool = cpu_to_le32((u32) spec->pool_id);
3675
Alex Elderc53d5892012-10-25 23:34:42 -05003676 return rbd_dev;
3677}
3678
3679static void rbd_dev_destroy(struct rbd_device *rbd_dev)
3680{
Alex Elderc53d5892012-10-25 23:34:42 -05003681 rbd_put_client(rbd_dev->rbd_client);
3682 rbd_spec_put(rbd_dev->spec);
3683 kfree(rbd_dev);
3684}
3685
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003686/*
Alex Elder9d475de2012-07-03 16:01:19 -05003687 * Get the size and object order for an image snapshot, or if
3688 * snap_id is CEPH_NOSNAP, gets this information for the base
3689 * image.
3690 */
3691static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
3692 u8 *order, u64 *snap_size)
3693{
3694 __le64 snapid = cpu_to_le64(snap_id);
3695 int ret;
3696 struct {
3697 u8 order;
3698 __le64 size;
3699 } __attribute__ ((packed)) size_buf = { 0 };
3700
Alex Elder36be9a72013-01-19 00:30:28 -06003701 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder9d475de2012-07-03 16:01:19 -05003702 "rbd", "get_size",
Alex Elder41579762013-04-21 12:14:45 -05003703 &snapid, sizeof (snapid),
Alex Eldere2a58ee2013-04-30 00:44:33 -05003704 &size_buf, sizeof (size_buf));
Alex Elder36be9a72013-01-19 00:30:28 -06003705 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder9d475de2012-07-03 16:01:19 -05003706 if (ret < 0)
3707 return ret;
Alex Elder57385b52013-04-21 12:14:45 -05003708 if (ret < sizeof (size_buf))
3709 return -ERANGE;
Alex Elder9d475de2012-07-03 16:01:19 -05003710
Alex Elderc86f86e2013-04-25 15:09:41 -05003711 if (order)
3712 *order = size_buf.order;
Alex Elder9d475de2012-07-03 16:01:19 -05003713 *snap_size = le64_to_cpu(size_buf.size);
3714
3715 dout(" snap_id 0x%016llx order = %u, snap_size = %llu\n",
Alex Elder57385b52013-04-21 12:14:45 -05003716 (unsigned long long)snap_id, (unsigned int)*order,
3717 (unsigned long long)*snap_size);
Alex Elder9d475de2012-07-03 16:01:19 -05003718
3719 return 0;
3720}
3721
3722static int rbd_dev_v2_image_size(struct rbd_device *rbd_dev)
3723{
3724 return _rbd_dev_v2_snap_size(rbd_dev, CEPH_NOSNAP,
3725 &rbd_dev->header.obj_order,
3726 &rbd_dev->header.image_size);
3727}
3728
Alex Elder1e130192012-07-03 16:01:19 -05003729static int rbd_dev_v2_object_prefix(struct rbd_device *rbd_dev)
3730{
3731 void *reply_buf;
3732 int ret;
3733 void *p;
3734
3735 reply_buf = kzalloc(RBD_OBJ_PREFIX_LEN_MAX, GFP_KERNEL);
3736 if (!reply_buf)
3737 return -ENOMEM;
3738
Alex Elder36be9a72013-01-19 00:30:28 -06003739 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder41579762013-04-21 12:14:45 -05003740 "rbd", "get_object_prefix", NULL, 0,
Alex Eldere2a58ee2013-04-30 00:44:33 -05003741 reply_buf, RBD_OBJ_PREFIX_LEN_MAX);
Alex Elder36be9a72013-01-19 00:30:28 -06003742 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder1e130192012-07-03 16:01:19 -05003743 if (ret < 0)
3744 goto out;
3745
3746 p = reply_buf;
3747 rbd_dev->header.object_prefix = ceph_extract_encoded_string(&p,
Alex Elder57385b52013-04-21 12:14:45 -05003748 p + ret, NULL, GFP_NOIO);
3749 ret = 0;
Alex Elder1e130192012-07-03 16:01:19 -05003750
3751 if (IS_ERR(rbd_dev->header.object_prefix)) {
3752 ret = PTR_ERR(rbd_dev->header.object_prefix);
3753 rbd_dev->header.object_prefix = NULL;
3754 } else {
3755 dout(" object_prefix = %s\n", rbd_dev->header.object_prefix);
3756 }
Alex Elder1e130192012-07-03 16:01:19 -05003757out:
3758 kfree(reply_buf);
3759
3760 return ret;
3761}
3762
Alex Elderb1b54022012-07-03 16:01:19 -05003763static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
3764 u64 *snap_features)
3765{
3766 __le64 snapid = cpu_to_le64(snap_id);
3767 struct {
3768 __le64 features;
3769 __le64 incompat;
Alex Elder41579762013-04-21 12:14:45 -05003770 } __attribute__ ((packed)) features_buf = { 0 };
Alex Elderd8891402012-10-09 13:50:17 -07003771 u64 incompat;
Alex Elderb1b54022012-07-03 16:01:19 -05003772 int ret;
3773
Alex Elder36be9a72013-01-19 00:30:28 -06003774 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elderb1b54022012-07-03 16:01:19 -05003775 "rbd", "get_features",
Alex Elder41579762013-04-21 12:14:45 -05003776 &snapid, sizeof (snapid),
Alex Eldere2a58ee2013-04-30 00:44:33 -05003777 &features_buf, sizeof (features_buf));
Alex Elder36be9a72013-01-19 00:30:28 -06003778 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elderb1b54022012-07-03 16:01:19 -05003779 if (ret < 0)
3780 return ret;
Alex Elder57385b52013-04-21 12:14:45 -05003781 if (ret < sizeof (features_buf))
3782 return -ERANGE;
Alex Elderd8891402012-10-09 13:50:17 -07003783
3784 incompat = le64_to_cpu(features_buf.incompat);
Alex Elder5cbf6f122013-04-11 09:29:48 -05003785 if (incompat & ~RBD_FEATURES_SUPPORTED)
Alex Elderb8f5c6e2012-11-01 08:39:26 -05003786 return -ENXIO;
Alex Elderd8891402012-10-09 13:50:17 -07003787
Alex Elderb1b54022012-07-03 16:01:19 -05003788 *snap_features = le64_to_cpu(features_buf.features);
3789
3790 dout(" snap_id 0x%016llx features = 0x%016llx incompat = 0x%016llx\n",
Alex Elder57385b52013-04-21 12:14:45 -05003791 (unsigned long long)snap_id,
3792 (unsigned long long)*snap_features,
3793 (unsigned long long)le64_to_cpu(features_buf.incompat));
Alex Elderb1b54022012-07-03 16:01:19 -05003794
3795 return 0;
3796}
3797
3798static int rbd_dev_v2_features(struct rbd_device *rbd_dev)
3799{
3800 return _rbd_dev_v2_snap_features(rbd_dev, CEPH_NOSNAP,
3801 &rbd_dev->header.features);
3802}
3803
Alex Elder86b00e02012-10-25 23:34:42 -05003804static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev)
3805{
3806 struct rbd_spec *parent_spec;
3807 size_t size;
3808 void *reply_buf = NULL;
3809 __le64 snapid;
3810 void *p;
3811 void *end;
Alex Elder642a2532013-05-06 17:40:33 -05003812 u64 pool_id;
Alex Elder86b00e02012-10-25 23:34:42 -05003813 char *image_id;
3814 u64 overlap;
Alex Elder86b00e02012-10-25 23:34:42 -05003815 int ret;
3816
3817 parent_spec = rbd_spec_alloc();
3818 if (!parent_spec)
3819 return -ENOMEM;
3820
3821 size = sizeof (__le64) + /* pool_id */
3822 sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX + /* image_id */
3823 sizeof (__le64) + /* snap_id */
3824 sizeof (__le64); /* overlap */
3825 reply_buf = kmalloc(size, GFP_KERNEL);
3826 if (!reply_buf) {
3827 ret = -ENOMEM;
3828 goto out_err;
3829 }
3830
3831 snapid = cpu_to_le64(CEPH_NOSNAP);
Alex Elder36be9a72013-01-19 00:30:28 -06003832 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder86b00e02012-10-25 23:34:42 -05003833 "rbd", "get_parent",
Alex Elder41579762013-04-21 12:14:45 -05003834 &snapid, sizeof (snapid),
Alex Eldere2a58ee2013-04-30 00:44:33 -05003835 reply_buf, size);
Alex Elder36be9a72013-01-19 00:30:28 -06003836 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder86b00e02012-10-25 23:34:42 -05003837 if (ret < 0)
3838 goto out_err;
3839
Alex Elder86b00e02012-10-25 23:34:42 -05003840 p = reply_buf;
Alex Elder57385b52013-04-21 12:14:45 -05003841 end = reply_buf + ret;
3842 ret = -ERANGE;
Alex Elder642a2532013-05-06 17:40:33 -05003843 ceph_decode_64_safe(&p, end, pool_id, out_err);
Alex Elder392a9da2013-05-06 17:40:33 -05003844 if (pool_id == CEPH_NOPOOL) {
3845 /*
3846 * Either the parent never existed, or we have
3847 * record of it but the image got flattened so it no
3848 * longer has a parent. When the parent of a
3849 * layered image disappears we immediately set the
3850 * overlap to 0. The effect of this is that all new
3851 * requests will be treated as if the image had no
3852 * parent.
3853 */
3854 if (rbd_dev->parent_overlap) {
3855 rbd_dev->parent_overlap = 0;
3856 smp_mb();
3857 rbd_dev_parent_put(rbd_dev);
3858 pr_info("%s: clone image has been flattened\n",
3859 rbd_dev->disk->disk_name);
3860 }
3861
Alex Elder86b00e02012-10-25 23:34:42 -05003862 goto out; /* No parent? No problem. */
Alex Elder392a9da2013-05-06 17:40:33 -05003863 }
Alex Elder86b00e02012-10-25 23:34:42 -05003864
Alex Elder0903e872012-11-14 12:25:19 -06003865 /* The ceph file layout needs to fit pool id in 32 bits */
3866
3867 ret = -EIO;
Alex Elder642a2532013-05-06 17:40:33 -05003868 if (pool_id > (u64)U32_MAX) {
Alex Elderc0cd10db2013-04-26 09:43:47 -05003869 rbd_warn(NULL, "parent pool id too large (%llu > %u)\n",
Alex Elder642a2532013-05-06 17:40:33 -05003870 (unsigned long long)pool_id, U32_MAX);
Alex Elder57385b52013-04-21 12:14:45 -05003871 goto out_err;
Alex Elderc0cd10db2013-04-26 09:43:47 -05003872 }
Alex Elder642a2532013-05-06 17:40:33 -05003873 parent_spec->pool_id = pool_id;
Alex Elder0903e872012-11-14 12:25:19 -06003874
Alex Elder979ed482012-11-01 08:39:26 -05003875 image_id = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
Alex Elder86b00e02012-10-25 23:34:42 -05003876 if (IS_ERR(image_id)) {
3877 ret = PTR_ERR(image_id);
3878 goto out_err;
3879 }
3880 parent_spec->image_id = image_id;
3881 ceph_decode_64_safe(&p, end, parent_spec->snap_id, out_err);
3882 ceph_decode_64_safe(&p, end, overlap, out_err);
3883
Alex Elder70cf49c2013-05-06 17:40:33 -05003884 if (overlap) {
Alex Elder642a2532013-05-06 17:40:33 -05003885 rbd_spec_put(rbd_dev->parent_spec);
Alex Elder70cf49c2013-05-06 17:40:33 -05003886 rbd_dev->parent_spec = parent_spec;
3887 parent_spec = NULL; /* rbd_dev now owns this */
3888 rbd_dev->parent_overlap = overlap;
3889 } else {
3890 rbd_warn(rbd_dev, "ignoring parent of clone with overlap 0\n");
3891 }
Alex Elder86b00e02012-10-25 23:34:42 -05003892out:
3893 ret = 0;
3894out_err:
3895 kfree(reply_buf);
3896 rbd_spec_put(parent_spec);
3897
3898 return ret;
3899}
3900
Alex Eldercc070d52013-04-21 12:14:45 -05003901static int rbd_dev_v2_striping_info(struct rbd_device *rbd_dev)
3902{
3903 struct {
3904 __le64 stripe_unit;
3905 __le64 stripe_count;
3906 } __attribute__ ((packed)) striping_info_buf = { 0 };
3907 size_t size = sizeof (striping_info_buf);
3908 void *p;
3909 u64 obj_size;
3910 u64 stripe_unit;
3911 u64 stripe_count;
3912 int ret;
3913
3914 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3915 "rbd", "get_stripe_unit_count", NULL, 0,
Alex Eldere2a58ee2013-04-30 00:44:33 -05003916 (char *)&striping_info_buf, size);
Alex Eldercc070d52013-04-21 12:14:45 -05003917 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3918 if (ret < 0)
3919 return ret;
3920 if (ret < size)
3921 return -ERANGE;
3922
3923 /*
3924 * We don't actually support the "fancy striping" feature
3925 * (STRIPINGV2) yet, but if the striping sizes are the
3926 * defaults the behavior is the same as before. So find
3927 * out, and only fail if the image has non-default values.
3928 */
3929 ret = -EINVAL;
3930 obj_size = (u64)1 << rbd_dev->header.obj_order;
3931 p = &striping_info_buf;
3932 stripe_unit = ceph_decode_64(&p);
3933 if (stripe_unit != obj_size) {
3934 rbd_warn(rbd_dev, "unsupported stripe unit "
3935 "(got %llu want %llu)",
3936 stripe_unit, obj_size);
3937 return -EINVAL;
3938 }
3939 stripe_count = ceph_decode_64(&p);
3940 if (stripe_count != 1) {
3941 rbd_warn(rbd_dev, "unsupported stripe count "
3942 "(got %llu want 1)", stripe_count);
3943 return -EINVAL;
3944 }
Alex Elder500d0c02013-04-26 09:43:47 -05003945 rbd_dev->header.stripe_unit = stripe_unit;
3946 rbd_dev->header.stripe_count = stripe_count;
Alex Eldercc070d52013-04-21 12:14:45 -05003947
3948 return 0;
3949}
3950
Alex Elder9e15b772012-10-30 19:40:33 -05003951static char *rbd_dev_image_name(struct rbd_device *rbd_dev)
3952{
3953 size_t image_id_size;
3954 char *image_id;
3955 void *p;
3956 void *end;
3957 size_t size;
3958 void *reply_buf = NULL;
3959 size_t len = 0;
3960 char *image_name = NULL;
3961 int ret;
3962
3963 rbd_assert(!rbd_dev->spec->image_name);
3964
Alex Elder69e7a022012-11-01 08:39:26 -05003965 len = strlen(rbd_dev->spec->image_id);
3966 image_id_size = sizeof (__le32) + len;
Alex Elder9e15b772012-10-30 19:40:33 -05003967 image_id = kmalloc(image_id_size, GFP_KERNEL);
3968 if (!image_id)
3969 return NULL;
3970
3971 p = image_id;
Alex Elder41579762013-04-21 12:14:45 -05003972 end = image_id + image_id_size;
Alex Elder57385b52013-04-21 12:14:45 -05003973 ceph_encode_string(&p, end, rbd_dev->spec->image_id, (u32)len);
Alex Elder9e15b772012-10-30 19:40:33 -05003974
3975 size = sizeof (__le32) + RBD_IMAGE_NAME_LEN_MAX;
3976 reply_buf = kmalloc(size, GFP_KERNEL);
3977 if (!reply_buf)
3978 goto out;
3979
Alex Elder36be9a72013-01-19 00:30:28 -06003980 ret = rbd_obj_method_sync(rbd_dev, RBD_DIRECTORY,
Alex Elder9e15b772012-10-30 19:40:33 -05003981 "rbd", "dir_get_name",
3982 image_id, image_id_size,
Alex Eldere2a58ee2013-04-30 00:44:33 -05003983 reply_buf, size);
Alex Elder9e15b772012-10-30 19:40:33 -05003984 if (ret < 0)
3985 goto out;
3986 p = reply_buf;
Alex Elderf40eb342013-04-25 15:09:42 -05003987 end = reply_buf + ret;
3988
Alex Elder9e15b772012-10-30 19:40:33 -05003989 image_name = ceph_extract_encoded_string(&p, end, &len, GFP_KERNEL);
3990 if (IS_ERR(image_name))
3991 image_name = NULL;
3992 else
3993 dout("%s: name is %s len is %zd\n", __func__, image_name, len);
3994out:
3995 kfree(reply_buf);
3996 kfree(image_id);
3997
3998 return image_name;
3999}
4000
Alex Elder2ad3d712013-04-30 00:44:33 -05004001static u64 rbd_v1_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4002{
4003 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
4004 const char *snap_name;
4005 u32 which = 0;
4006
4007 /* Skip over names until we find the one we are looking for */
4008
4009 snap_name = rbd_dev->header.snap_names;
4010 while (which < snapc->num_snaps) {
4011 if (!strcmp(name, snap_name))
4012 return snapc->snaps[which];
4013 snap_name += strlen(snap_name) + 1;
4014 which++;
4015 }
4016 return CEPH_NOSNAP;
4017}
4018
4019static u64 rbd_v2_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4020{
4021 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
4022 u32 which;
4023 bool found = false;
4024 u64 snap_id;
4025
4026 for (which = 0; !found && which < snapc->num_snaps; which++) {
4027 const char *snap_name;
4028
4029 snap_id = snapc->snaps[which];
4030 snap_name = rbd_dev_v2_snap_name(rbd_dev, snap_id);
4031 if (IS_ERR(snap_name))
4032 break;
4033 found = !strcmp(name, snap_name);
4034 kfree(snap_name);
4035 }
4036 return found ? snap_id : CEPH_NOSNAP;
4037}
4038
4039/*
4040 * Assumes name is never RBD_SNAP_HEAD_NAME; returns CEPH_NOSNAP if
4041 * no snapshot by that name is found, or if an error occurs.
4042 */
4043static u64 rbd_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4044{
4045 if (rbd_dev->image_format == 1)
4046 return rbd_v1_snap_id_by_name(rbd_dev, name);
4047
4048 return rbd_v2_snap_id_by_name(rbd_dev, name);
4049}
4050
Alex Elder9e15b772012-10-30 19:40:33 -05004051/*
Alex Elder2e9f7f12013-04-26 09:43:48 -05004052 * When an rbd image has a parent image, it is identified by the
4053 * pool, image, and snapshot ids (not names). This function fills
4054 * in the names for those ids. (It's OK if we can't figure out the
4055 * name for an image id, but the pool and snapshot ids should always
4056 * exist and have names.) All names in an rbd spec are dynamically
4057 * allocated.
Alex Eldere1d42132013-04-25 23:15:08 -05004058 *
4059 * When an image being mapped (not a parent) is probed, we have the
4060 * pool name and pool id, image name and image id, and the snapshot
4061 * name. The only thing we're missing is the snapshot id.
Alex Elder9e15b772012-10-30 19:40:33 -05004062 */
Alex Elder2e9f7f12013-04-26 09:43:48 -05004063static int rbd_dev_spec_update(struct rbd_device *rbd_dev)
Alex Elder9e15b772012-10-30 19:40:33 -05004064{
Alex Elder2e9f7f12013-04-26 09:43:48 -05004065 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
4066 struct rbd_spec *spec = rbd_dev->spec;
4067 const char *pool_name;
4068 const char *image_name;
4069 const char *snap_name;
Alex Elder9e15b772012-10-30 19:40:33 -05004070 int ret;
4071
Alex Eldere1d42132013-04-25 23:15:08 -05004072 /*
4073 * An image being mapped will have the pool name (etc.), but
4074 * we need to look up the snapshot id.
4075 */
Alex Elder2e9f7f12013-04-26 09:43:48 -05004076 if (spec->pool_name) {
4077 if (strcmp(spec->snap_name, RBD_SNAP_HEAD_NAME)) {
Alex Elder2ad3d712013-04-30 00:44:33 -05004078 u64 snap_id;
Alex Eldere1d42132013-04-25 23:15:08 -05004079
Alex Elder2ad3d712013-04-30 00:44:33 -05004080 snap_id = rbd_snap_id_by_name(rbd_dev, spec->snap_name);
4081 if (snap_id == CEPH_NOSNAP)
Alex Eldere1d42132013-04-25 23:15:08 -05004082 return -ENOENT;
Alex Elder2ad3d712013-04-30 00:44:33 -05004083 spec->snap_id = snap_id;
Alex Eldere1d42132013-04-25 23:15:08 -05004084 } else {
Alex Elder2e9f7f12013-04-26 09:43:48 -05004085 spec->snap_id = CEPH_NOSNAP;
Alex Eldere1d42132013-04-25 23:15:08 -05004086 }
4087
4088 return 0;
4089 }
Alex Elder9e15b772012-10-30 19:40:33 -05004090
Alex Elder2e9f7f12013-04-26 09:43:48 -05004091 /* Get the pool name; we have to make our own copy of this */
Alex Elder9e15b772012-10-30 19:40:33 -05004092
Alex Elder2e9f7f12013-04-26 09:43:48 -05004093 pool_name = ceph_pg_pool_name_by_id(osdc->osdmap, spec->pool_id);
4094 if (!pool_name) {
4095 rbd_warn(rbd_dev, "no pool with id %llu", spec->pool_id);
Alex Elder935dc892012-11-01 10:17:15 -05004096 return -EIO;
4097 }
Alex Elder2e9f7f12013-04-26 09:43:48 -05004098 pool_name = kstrdup(pool_name, GFP_KERNEL);
4099 if (!pool_name)
Alex Elder9e15b772012-10-30 19:40:33 -05004100 return -ENOMEM;
4101
4102 /* Fetch the image name; tolerate failure here */
4103
Alex Elder2e9f7f12013-04-26 09:43:48 -05004104 image_name = rbd_dev_image_name(rbd_dev);
4105 if (!image_name)
Alex Elder06ecc6c2012-11-01 10:17:15 -05004106 rbd_warn(rbd_dev, "unable to get image name");
Alex Elder9e15b772012-10-30 19:40:33 -05004107
Alex Elder2e9f7f12013-04-26 09:43:48 -05004108 /* Look up the snapshot name, and make a copy */
Alex Elder9e15b772012-10-30 19:40:33 -05004109
Alex Elder2e9f7f12013-04-26 09:43:48 -05004110 snap_name = rbd_snap_name(rbd_dev, spec->snap_id);
4111 if (!snap_name) {
Alex Elder2e9f7f12013-04-26 09:43:48 -05004112 ret = -ENOMEM;
Alex Elder9e15b772012-10-30 19:40:33 -05004113 goto out_err;
Alex Elder2e9f7f12013-04-26 09:43:48 -05004114 }
4115
4116 spec->pool_name = pool_name;
4117 spec->image_name = image_name;
4118 spec->snap_name = snap_name;
Alex Elder9e15b772012-10-30 19:40:33 -05004119
4120 return 0;
4121out_err:
Alex Elder2e9f7f12013-04-26 09:43:48 -05004122 kfree(image_name);
4123 kfree(pool_name);
Alex Elder9e15b772012-10-30 19:40:33 -05004124
4125 return ret;
4126}
4127
Alex Eldercc4a38bd2013-04-30 00:44:33 -05004128static int rbd_dev_v2_snap_context(struct rbd_device *rbd_dev)
Alex Elder35d489f2012-07-03 16:01:19 -05004129{
4130 size_t size;
4131 int ret;
4132 void *reply_buf;
4133 void *p;
4134 void *end;
4135 u64 seq;
4136 u32 snap_count;
4137 struct ceph_snap_context *snapc;
4138 u32 i;
4139
4140 /*
4141 * We'll need room for the seq value (maximum snapshot id),
4142 * snapshot count, and array of that many snapshot ids.
4143 * For now we have a fixed upper limit on the number we're
4144 * prepared to receive.
4145 */
4146 size = sizeof (__le64) + sizeof (__le32) +
4147 RBD_MAX_SNAP_COUNT * sizeof (__le64);
4148 reply_buf = kzalloc(size, GFP_KERNEL);
4149 if (!reply_buf)
4150 return -ENOMEM;
4151
Alex Elder36be9a72013-01-19 00:30:28 -06004152 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder41579762013-04-21 12:14:45 -05004153 "rbd", "get_snapcontext", NULL, 0,
Alex Eldere2a58ee2013-04-30 00:44:33 -05004154 reply_buf, size);
Alex Elder36be9a72013-01-19 00:30:28 -06004155 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder35d489f2012-07-03 16:01:19 -05004156 if (ret < 0)
4157 goto out;
4158
Alex Elder35d489f2012-07-03 16:01:19 -05004159 p = reply_buf;
Alex Elder57385b52013-04-21 12:14:45 -05004160 end = reply_buf + ret;
4161 ret = -ERANGE;
Alex Elder35d489f2012-07-03 16:01:19 -05004162 ceph_decode_64_safe(&p, end, seq, out);
4163 ceph_decode_32_safe(&p, end, snap_count, out);
4164
4165 /*
4166 * Make sure the reported number of snapshot ids wouldn't go
4167 * beyond the end of our buffer. But before checking that,
4168 * make sure the computed size of the snapshot context we
4169 * allocate is representable in a size_t.
4170 */
4171 if (snap_count > (SIZE_MAX - sizeof (struct ceph_snap_context))
4172 / sizeof (u64)) {
4173 ret = -EINVAL;
4174 goto out;
4175 }
4176 if (!ceph_has_room(&p, end, snap_count * sizeof (__le64)))
4177 goto out;
Alex Elder468521c2013-04-26 09:43:47 -05004178 ret = 0;
Alex Elder35d489f2012-07-03 16:01:19 -05004179
Alex Elder812164f82013-04-30 00:44:32 -05004180 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
Alex Elder35d489f2012-07-03 16:01:19 -05004181 if (!snapc) {
4182 ret = -ENOMEM;
4183 goto out;
4184 }
Alex Elder35d489f2012-07-03 16:01:19 -05004185 snapc->seq = seq;
Alex Elder35d489f2012-07-03 16:01:19 -05004186 for (i = 0; i < snap_count; i++)
4187 snapc->snaps[i] = ceph_decode_64(&p);
4188
Alex Elder49ece552013-05-06 08:37:00 -05004189 ceph_put_snap_context(rbd_dev->header.snapc);
Alex Elder35d489f2012-07-03 16:01:19 -05004190 rbd_dev->header.snapc = snapc;
4191
4192 dout(" snap context seq = %llu, snap_count = %u\n",
Alex Elder57385b52013-04-21 12:14:45 -05004193 (unsigned long long)seq, (unsigned int)snap_count);
Alex Elder35d489f2012-07-03 16:01:19 -05004194out:
4195 kfree(reply_buf);
4196
Alex Elder57385b52013-04-21 12:14:45 -05004197 return ret;
Alex Elder35d489f2012-07-03 16:01:19 -05004198}
4199
Alex Elder54cac612013-04-30 00:44:33 -05004200static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
4201 u64 snap_id)
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004202{
4203 size_t size;
4204 void *reply_buf;
Alex Elder54cac612013-04-30 00:44:33 -05004205 __le64 snapid;
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004206 int ret;
4207 void *p;
4208 void *end;
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004209 char *snap_name;
4210
4211 size = sizeof (__le32) + RBD_MAX_SNAP_NAME_LEN;
4212 reply_buf = kmalloc(size, GFP_KERNEL);
4213 if (!reply_buf)
4214 return ERR_PTR(-ENOMEM);
4215
Alex Elder54cac612013-04-30 00:44:33 -05004216 snapid = cpu_to_le64(snap_id);
Alex Elder36be9a72013-01-19 00:30:28 -06004217 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004218 "rbd", "get_snapshot_name",
Alex Elder54cac612013-04-30 00:44:33 -05004219 &snapid, sizeof (snapid),
Alex Eldere2a58ee2013-04-30 00:44:33 -05004220 reply_buf, size);
Alex Elder36be9a72013-01-19 00:30:28 -06004221 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elderf40eb342013-04-25 15:09:42 -05004222 if (ret < 0) {
4223 snap_name = ERR_PTR(ret);
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004224 goto out;
Alex Elderf40eb342013-04-25 15:09:42 -05004225 }
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004226
4227 p = reply_buf;
Alex Elderf40eb342013-04-25 15:09:42 -05004228 end = reply_buf + ret;
Alex Eldere5c35532012-10-25 23:34:41 -05004229 snap_name = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
Alex Elderf40eb342013-04-25 15:09:42 -05004230 if (IS_ERR(snap_name))
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004231 goto out;
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004232
Alex Elderf40eb342013-04-25 15:09:42 -05004233 dout(" snap_id 0x%016llx snap_name = %s\n",
Alex Elder54cac612013-04-30 00:44:33 -05004234 (unsigned long long)snap_id, snap_name);
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004235out:
4236 kfree(reply_buf);
4237
Alex Elderf40eb342013-04-25 15:09:42 -05004238 return snap_name;
Alex Elderb8b1e2d2012-07-03 16:01:19 -05004239}
4240
Alex Elder2df3fac2013-05-06 09:51:30 -05004241static int rbd_dev_v2_header_info(struct rbd_device *rbd_dev)
Alex Elder117973f2012-08-31 17:29:55 -05004242{
Alex Elder2df3fac2013-05-06 09:51:30 -05004243 bool first_time = rbd_dev->header.object_prefix == NULL;
Alex Elder117973f2012-08-31 17:29:55 -05004244 int ret;
Alex Elder117973f2012-08-31 17:29:55 -05004245
4246 down_write(&rbd_dev->header_rwsem);
4247
Alex Elder2df3fac2013-05-06 09:51:30 -05004248 if (first_time) {
4249 ret = rbd_dev_v2_header_onetime(rbd_dev);
4250 if (ret)
4251 goto out;
4252 }
4253
Alex Elder642a2532013-05-06 17:40:33 -05004254 /*
4255 * If the image supports layering, get the parent info. We
4256 * need to probe the first time regardless. Thereafter we
4257 * only need to if there's a parent, to see if it has
4258 * disappeared due to the mapped image getting flattened.
4259 */
4260 if (rbd_dev->header.features & RBD_FEATURE_LAYERING &&
4261 (first_time || rbd_dev->parent_spec)) {
4262 bool warn;
4263
4264 ret = rbd_dev_v2_parent_info(rbd_dev);
4265 if (ret)
4266 goto out;
4267
4268 /*
4269 * Print a warning if this is the initial probe and
4270 * the image has a parent. Don't print it if the
4271 * image now being probed is itself a parent. We
4272 * can tell at this point because we won't know its
4273 * pool name yet (just its pool id).
4274 */
4275 warn = rbd_dev->parent_spec && rbd_dev->spec->pool_name;
4276 if (first_time && warn)
4277 rbd_warn(rbd_dev, "WARNING: kernel layering "
4278 "is EXPERIMENTAL!");
4279 }
4280
Alex Elder117973f2012-08-31 17:29:55 -05004281 ret = rbd_dev_v2_image_size(rbd_dev);
4282 if (ret)
4283 goto out;
Alex Elder642a2532013-05-06 17:40:33 -05004284
Alex Elder29334ba2013-05-06 07:40:30 -05004285 if (rbd_dev->spec->snap_id == CEPH_NOSNAP)
4286 if (rbd_dev->mapping.size != rbd_dev->header.image_size)
4287 rbd_dev->mapping.size = rbd_dev->header.image_size;
Alex Elder117973f2012-08-31 17:29:55 -05004288
Alex Eldercc4a38bd2013-04-30 00:44:33 -05004289 ret = rbd_dev_v2_snap_context(rbd_dev);
Alex Elder117973f2012-08-31 17:29:55 -05004290 dout("rbd_dev_v2_snap_context returned %d\n", ret);
Alex Elder117973f2012-08-31 17:29:55 -05004291out:
4292 up_write(&rbd_dev->header_rwsem);
4293
4294 return ret;
4295}
4296
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004297static int rbd_bus_add_dev(struct rbd_device *rbd_dev)
4298{
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004299 struct device *dev;
Alex Eldercd789ab2012-08-30 00:16:38 -05004300 int ret;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004301
4302 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004303
Alex Eldercd789ab2012-08-30 00:16:38 -05004304 dev = &rbd_dev->dev;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004305 dev->bus = &rbd_bus_type;
4306 dev->type = &rbd_device_type;
4307 dev->parent = &rbd_root_dev;
Alex Elder200a6a82013-04-28 23:32:34 -05004308 dev->release = rbd_dev_device_release;
Alex Elderde71a292012-07-03 16:01:19 -05004309 dev_set_name(dev, "%d", rbd_dev->dev_id);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004310 ret = device_register(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004311
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004312 mutex_unlock(&ctl_mutex);
Alex Eldercd789ab2012-08-30 00:16:38 -05004313
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004314 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004315}
4316
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004317static void rbd_bus_del_dev(struct rbd_device *rbd_dev)
4318{
4319 device_unregister(&rbd_dev->dev);
4320}
4321
Alex Eldere2839302012-08-29 17:11:06 -05004322static atomic64_t rbd_dev_id_max = ATOMIC64_INIT(0);
Alex Elder1ddbe942012-01-29 13:57:44 -06004323
4324/*
Alex Elder499afd52012-02-02 08:13:29 -06004325 * Get a unique rbd identifier for the given new rbd_dev, and add
4326 * the rbd_dev to the global list. The minimum rbd id is 1.
Alex Elder1ddbe942012-01-29 13:57:44 -06004327 */
Alex Eldere2839302012-08-29 17:11:06 -05004328static void rbd_dev_id_get(struct rbd_device *rbd_dev)
Alex Elderb7f23c32012-01-29 13:57:43 -06004329{
Alex Eldere2839302012-08-29 17:11:06 -05004330 rbd_dev->dev_id = atomic64_inc_return(&rbd_dev_id_max);
Alex Elder499afd52012-02-02 08:13:29 -06004331
4332 spin_lock(&rbd_dev_list_lock);
4333 list_add_tail(&rbd_dev->node, &rbd_dev_list);
4334 spin_unlock(&rbd_dev_list_lock);
Alex Eldere2839302012-08-29 17:11:06 -05004335 dout("rbd_dev %p given dev id %llu\n", rbd_dev,
4336 (unsigned long long) rbd_dev->dev_id);
Alex Elder1ddbe942012-01-29 13:57:44 -06004337}
Alex Elderb7f23c32012-01-29 13:57:43 -06004338
Alex Elder1ddbe942012-01-29 13:57:44 -06004339/*
Alex Elder499afd52012-02-02 08:13:29 -06004340 * Remove an rbd_dev from the global list, and record that its
4341 * identifier is no longer in use.
Alex Elder1ddbe942012-01-29 13:57:44 -06004342 */
Alex Eldere2839302012-08-29 17:11:06 -05004343static void rbd_dev_id_put(struct rbd_device *rbd_dev)
Alex Elder1ddbe942012-01-29 13:57:44 -06004344{
Alex Elderd184f6b2012-01-29 13:57:44 -06004345 struct list_head *tmp;
Alex Elderde71a292012-07-03 16:01:19 -05004346 int rbd_id = rbd_dev->dev_id;
Alex Elderd184f6b2012-01-29 13:57:44 -06004347 int max_id;
4348
Alex Elderaafb2302012-09-06 16:00:54 -05004349 rbd_assert(rbd_id > 0);
Alex Elder499afd52012-02-02 08:13:29 -06004350
Alex Eldere2839302012-08-29 17:11:06 -05004351 dout("rbd_dev %p released dev id %llu\n", rbd_dev,
4352 (unsigned long long) rbd_dev->dev_id);
Alex Elder499afd52012-02-02 08:13:29 -06004353 spin_lock(&rbd_dev_list_lock);
4354 list_del_init(&rbd_dev->node);
Alex Elderd184f6b2012-01-29 13:57:44 -06004355
4356 /*
4357 * If the id being "put" is not the current maximum, there
4358 * is nothing special we need to do.
4359 */
Alex Eldere2839302012-08-29 17:11:06 -05004360 if (rbd_id != atomic64_read(&rbd_dev_id_max)) {
Alex Elderd184f6b2012-01-29 13:57:44 -06004361 spin_unlock(&rbd_dev_list_lock);
4362 return;
4363 }
4364
4365 /*
4366 * We need to update the current maximum id. Search the
4367 * list to find out what it is. We're more likely to find
4368 * the maximum at the end, so search the list backward.
4369 */
4370 max_id = 0;
4371 list_for_each_prev(tmp, &rbd_dev_list) {
4372 struct rbd_device *rbd_dev;
4373
4374 rbd_dev = list_entry(tmp, struct rbd_device, node);
Alex Elderb213e0b2012-10-10 21:19:13 -07004375 if (rbd_dev->dev_id > max_id)
4376 max_id = rbd_dev->dev_id;
Alex Elderd184f6b2012-01-29 13:57:44 -06004377 }
Alex Elder499afd52012-02-02 08:13:29 -06004378 spin_unlock(&rbd_dev_list_lock);
Alex Elderb7f23c32012-01-29 13:57:43 -06004379
Alex Elder1ddbe942012-01-29 13:57:44 -06004380 /*
Alex Eldere2839302012-08-29 17:11:06 -05004381 * The max id could have been updated by rbd_dev_id_get(), in
Alex Elderd184f6b2012-01-29 13:57:44 -06004382 * which case it now accurately reflects the new maximum.
4383 * Be careful not to overwrite the maximum value in that
4384 * case.
Alex Elder1ddbe942012-01-29 13:57:44 -06004385 */
Alex Eldere2839302012-08-29 17:11:06 -05004386 atomic64_cmpxchg(&rbd_dev_id_max, rbd_id, max_id);
4387 dout(" max dev id has been reset\n");
Alex Elderb7f23c32012-01-29 13:57:43 -06004388}
4389
Alex Eldera725f65e2012-02-02 08:13:30 -06004390/*
Alex Eldere28fff262012-02-02 08:13:30 -06004391 * Skips over white space at *buf, and updates *buf to point to the
4392 * first found non-space character (if any). Returns the length of
Alex Elder593a9e72012-02-07 12:03:37 -06004393 * the token (string of non-white space characters) found. Note
4394 * that *buf must be terminated with '\0'.
Alex Eldere28fff262012-02-02 08:13:30 -06004395 */
4396static inline size_t next_token(const char **buf)
4397{
4398 /*
4399 * These are the characters that produce nonzero for
4400 * isspace() in the "C" and "POSIX" locales.
4401 */
4402 const char *spaces = " \f\n\r\t\v";
4403
4404 *buf += strspn(*buf, spaces); /* Find start of token */
4405
4406 return strcspn(*buf, spaces); /* Return token length */
4407}
4408
4409/*
4410 * Finds the next token in *buf, and if the provided token buffer is
4411 * big enough, copies the found token into it. The result, if
Alex Elder593a9e72012-02-07 12:03:37 -06004412 * copied, is guaranteed to be terminated with '\0'. Note that *buf
4413 * must be terminated with '\0' on entry.
Alex Eldere28fff262012-02-02 08:13:30 -06004414 *
4415 * Returns the length of the token found (not including the '\0').
4416 * Return value will be 0 if no token is found, and it will be >=
4417 * token_size if the token would not fit.
4418 *
Alex Elder593a9e72012-02-07 12:03:37 -06004419 * The *buf pointer will be updated to point beyond the end of the
Alex Eldere28fff262012-02-02 08:13:30 -06004420 * found token. Note that this occurs even if the token buffer is
4421 * too small to hold it.
4422 */
4423static inline size_t copy_token(const char **buf,
4424 char *token,
4425 size_t token_size)
4426{
4427 size_t len;
4428
4429 len = next_token(buf);
4430 if (len < token_size) {
4431 memcpy(token, *buf, len);
4432 *(token + len) = '\0';
4433 }
4434 *buf += len;
4435
4436 return len;
4437}
4438
4439/*
Alex Elderea3352f2012-07-09 21:04:23 -05004440 * Finds the next token in *buf, dynamically allocates a buffer big
4441 * enough to hold a copy of it, and copies the token into the new
4442 * buffer. The copy is guaranteed to be terminated with '\0'. Note
4443 * that a duplicate buffer is created even for a zero-length token.
4444 *
4445 * Returns a pointer to the newly-allocated duplicate, or a null
4446 * pointer if memory for the duplicate was not available. If
4447 * the lenp argument is a non-null pointer, the length of the token
4448 * (not including the '\0') is returned in *lenp.
4449 *
4450 * If successful, the *buf pointer will be updated to point beyond
4451 * the end of the found token.
4452 *
4453 * Note: uses GFP_KERNEL for allocation.
4454 */
4455static inline char *dup_token(const char **buf, size_t *lenp)
4456{
4457 char *dup;
4458 size_t len;
4459
4460 len = next_token(buf);
Alex Elder4caf35f2012-11-01 08:39:27 -05004461 dup = kmemdup(*buf, len + 1, GFP_KERNEL);
Alex Elderea3352f2012-07-09 21:04:23 -05004462 if (!dup)
4463 return NULL;
Alex Elderea3352f2012-07-09 21:04:23 -05004464 *(dup + len) = '\0';
4465 *buf += len;
4466
4467 if (lenp)
4468 *lenp = len;
4469
4470 return dup;
4471}
4472
4473/*
Alex Elder859c31d2012-10-25 23:34:42 -05004474 * Parse the options provided for an "rbd add" (i.e., rbd image
4475 * mapping) request. These arrive via a write to /sys/bus/rbd/add,
4476 * and the data written is passed here via a NUL-terminated buffer.
4477 * Returns 0 if successful or an error code otherwise.
Alex Elderd22f76e2012-07-12 10:46:35 -05004478 *
Alex Elder859c31d2012-10-25 23:34:42 -05004479 * The information extracted from these options is recorded in
4480 * the other parameters which return dynamically-allocated
4481 * structures:
4482 * ceph_opts
4483 * The address of a pointer that will refer to a ceph options
4484 * structure. Caller must release the returned pointer using
4485 * ceph_destroy_options() when it is no longer needed.
4486 * rbd_opts
4487 * Address of an rbd options pointer. Fully initialized by
4488 * this function; caller must release with kfree().
4489 * spec
4490 * Address of an rbd image specification pointer. Fully
4491 * initialized by this function based on parsed options.
4492 * Caller must release with rbd_spec_put().
4493 *
4494 * The options passed take this form:
4495 * <mon_addrs> <options> <pool_name> <image_name> [<snap_id>]
4496 * where:
4497 * <mon_addrs>
4498 * A comma-separated list of one or more monitor addresses.
4499 * A monitor address is an ip address, optionally followed
4500 * by a port number (separated by a colon).
4501 * I.e.: ip1[:port1][,ip2[:port2]...]
4502 * <options>
4503 * A comma-separated list of ceph and/or rbd options.
4504 * <pool_name>
4505 * The name of the rados pool containing the rbd image.
4506 * <image_name>
4507 * The name of the image in that pool to map.
4508 * <snap_id>
4509 * An optional snapshot id. If provided, the mapping will
4510 * present data from the image at the time that snapshot was
4511 * created. The image head is used if no snapshot id is
4512 * provided. Snapshot mappings are always read-only.
Alex Eldera725f65e2012-02-02 08:13:30 -06004513 */
Alex Elder859c31d2012-10-25 23:34:42 -05004514static int rbd_add_parse_args(const char *buf,
Alex Elderdc79b112012-10-25 23:34:41 -05004515 struct ceph_options **ceph_opts,
Alex Elder859c31d2012-10-25 23:34:42 -05004516 struct rbd_options **opts,
4517 struct rbd_spec **rbd_spec)
Alex Eldera725f65e2012-02-02 08:13:30 -06004518{
Alex Elderd22f76e2012-07-12 10:46:35 -05004519 size_t len;
Alex Elder859c31d2012-10-25 23:34:42 -05004520 char *options;
Alex Elder0ddebc02012-10-25 23:34:41 -05004521 const char *mon_addrs;
Alex Elderecb4dc22013-04-26 09:43:47 -05004522 char *snap_name;
Alex Elder0ddebc02012-10-25 23:34:41 -05004523 size_t mon_addrs_size;
Alex Elder859c31d2012-10-25 23:34:42 -05004524 struct rbd_spec *spec = NULL;
Alex Elder4e9afeb2012-10-25 23:34:41 -05004525 struct rbd_options *rbd_opts = NULL;
Alex Elder859c31d2012-10-25 23:34:42 -05004526 struct ceph_options *copts;
Alex Elderdc79b112012-10-25 23:34:41 -05004527 int ret;
Alex Eldere28fff262012-02-02 08:13:30 -06004528
4529 /* The first four tokens are required */
4530
Alex Elder7ef32142012-02-02 08:13:30 -06004531 len = next_token(&buf);
Alex Elder4fb5d6712012-11-01 10:17:15 -05004532 if (!len) {
4533 rbd_warn(NULL, "no monitor address(es) provided");
4534 return -EINVAL;
4535 }
Alex Elder0ddebc02012-10-25 23:34:41 -05004536 mon_addrs = buf;
Alex Elderf28e5652012-10-25 23:34:41 -05004537 mon_addrs_size = len + 1;
Alex Elder7ef32142012-02-02 08:13:30 -06004538 buf += len;
Alex Eldera725f65e2012-02-02 08:13:30 -06004539
Alex Elderdc79b112012-10-25 23:34:41 -05004540 ret = -EINVAL;
Alex Elderf28e5652012-10-25 23:34:41 -05004541 options = dup_token(&buf, NULL);
4542 if (!options)
Alex Elderdc79b112012-10-25 23:34:41 -05004543 return -ENOMEM;
Alex Elder4fb5d6712012-11-01 10:17:15 -05004544 if (!*options) {
4545 rbd_warn(NULL, "no options provided");
4546 goto out_err;
4547 }
Alex Eldera725f65e2012-02-02 08:13:30 -06004548
Alex Elder859c31d2012-10-25 23:34:42 -05004549 spec = rbd_spec_alloc();
4550 if (!spec)
Alex Elderf28e5652012-10-25 23:34:41 -05004551 goto out_mem;
Alex Elder859c31d2012-10-25 23:34:42 -05004552
4553 spec->pool_name = dup_token(&buf, NULL);
4554 if (!spec->pool_name)
4555 goto out_mem;
Alex Elder4fb5d6712012-11-01 10:17:15 -05004556 if (!*spec->pool_name) {
4557 rbd_warn(NULL, "no pool name provided");
4558 goto out_err;
4559 }
Alex Eldere28fff262012-02-02 08:13:30 -06004560
Alex Elder69e7a022012-11-01 08:39:26 -05004561 spec->image_name = dup_token(&buf, NULL);
Alex Elder859c31d2012-10-25 23:34:42 -05004562 if (!spec->image_name)
Alex Elderf28e5652012-10-25 23:34:41 -05004563 goto out_mem;
Alex Elder4fb5d6712012-11-01 10:17:15 -05004564 if (!*spec->image_name) {
4565 rbd_warn(NULL, "no image name provided");
4566 goto out_err;
4567 }
Alex Eldere28fff262012-02-02 08:13:30 -06004568
Alex Elderf28e5652012-10-25 23:34:41 -05004569 /*
4570 * Snapshot name is optional; default is to use "-"
4571 * (indicating the head/no snapshot).
4572 */
Alex Elder3feeb8942012-08-31 17:29:52 -05004573 len = next_token(&buf);
Alex Elder820a5f32012-07-09 21:04:24 -05004574 if (!len) {
Alex Elder3feeb8942012-08-31 17:29:52 -05004575 buf = RBD_SNAP_HEAD_NAME; /* No snapshot supplied */
4576 len = sizeof (RBD_SNAP_HEAD_NAME) - 1;
Alex Elderf28e5652012-10-25 23:34:41 -05004577 } else if (len > RBD_MAX_SNAP_NAME_LEN) {
Alex Elderdc79b112012-10-25 23:34:41 -05004578 ret = -ENAMETOOLONG;
Alex Elderf28e5652012-10-25 23:34:41 -05004579 goto out_err;
Alex Elder849b4262012-07-09 21:04:24 -05004580 }
Alex Elderecb4dc22013-04-26 09:43:47 -05004581 snap_name = kmemdup(buf, len + 1, GFP_KERNEL);
4582 if (!snap_name)
Alex Elderf28e5652012-10-25 23:34:41 -05004583 goto out_mem;
Alex Elderecb4dc22013-04-26 09:43:47 -05004584 *(snap_name + len) = '\0';
4585 spec->snap_name = snap_name;
Alex Eldere5c35532012-10-25 23:34:41 -05004586
Alex Elder0ddebc02012-10-25 23:34:41 -05004587 /* Initialize all rbd options to the defaults */
Alex Eldere28fff262012-02-02 08:13:30 -06004588
Alex Elder4e9afeb2012-10-25 23:34:41 -05004589 rbd_opts = kzalloc(sizeof (*rbd_opts), GFP_KERNEL);
4590 if (!rbd_opts)
4591 goto out_mem;
4592
4593 rbd_opts->read_only = RBD_READ_ONLY_DEFAULT;
Alex Elderd22f76e2012-07-12 10:46:35 -05004594
Alex Elder859c31d2012-10-25 23:34:42 -05004595 copts = ceph_parse_options(options, mon_addrs,
Alex Elder0ddebc02012-10-25 23:34:41 -05004596 mon_addrs + mon_addrs_size - 1,
Alex Elder4e9afeb2012-10-25 23:34:41 -05004597 parse_rbd_opts_token, rbd_opts);
Alex Elder859c31d2012-10-25 23:34:42 -05004598 if (IS_ERR(copts)) {
4599 ret = PTR_ERR(copts);
Alex Elderdc79b112012-10-25 23:34:41 -05004600 goto out_err;
4601 }
Alex Elder859c31d2012-10-25 23:34:42 -05004602 kfree(options);
4603
4604 *ceph_opts = copts;
Alex Elder4e9afeb2012-10-25 23:34:41 -05004605 *opts = rbd_opts;
Alex Elder859c31d2012-10-25 23:34:42 -05004606 *rbd_spec = spec;
Alex Elder0ddebc02012-10-25 23:34:41 -05004607
Alex Elderdc79b112012-10-25 23:34:41 -05004608 return 0;
Alex Elderf28e5652012-10-25 23:34:41 -05004609out_mem:
Alex Elderdc79b112012-10-25 23:34:41 -05004610 ret = -ENOMEM;
Alex Elderd22f76e2012-07-12 10:46:35 -05004611out_err:
Alex Elder859c31d2012-10-25 23:34:42 -05004612 kfree(rbd_opts);
4613 rbd_spec_put(spec);
Alex Elderf28e5652012-10-25 23:34:41 -05004614 kfree(options);
Alex Elderd22f76e2012-07-12 10:46:35 -05004615
Alex Elderdc79b112012-10-25 23:34:41 -05004616 return ret;
Alex Eldera725f65e2012-02-02 08:13:30 -06004617}
4618
Alex Elder589d30e2012-07-10 20:30:11 -05004619/*
4620 * An rbd format 2 image has a unique identifier, distinct from the
4621 * name given to it by the user. Internally, that identifier is
4622 * what's used to specify the names of objects related to the image.
4623 *
4624 * A special "rbd id" object is used to map an rbd image name to its
4625 * id. If that object doesn't exist, then there is no v2 rbd image
4626 * with the supplied name.
4627 *
4628 * This function will record the given rbd_dev's image_id field if
4629 * it can be determined, and in that case will return 0. If any
4630 * errors occur a negative errno will be returned and the rbd_dev's
4631 * image_id field will be unchanged (and should be NULL).
4632 */
4633static int rbd_dev_image_id(struct rbd_device *rbd_dev)
4634{
4635 int ret;
4636 size_t size;
4637 char *object_name;
4638 void *response;
Alex Elderc0fba362013-04-25 23:15:08 -05004639 char *image_id;
Alex Elder2f82ee52012-10-30 19:40:33 -05004640
Alex Elder589d30e2012-07-10 20:30:11 -05004641 /*
Alex Elder2c0d0a12012-10-30 19:40:33 -05004642 * When probing a parent image, the image id is already
4643 * known (and the image name likely is not). There's no
Alex Elderc0fba362013-04-25 23:15:08 -05004644 * need to fetch the image id again in this case. We
4645 * do still need to set the image format though.
Alex Elder2c0d0a12012-10-30 19:40:33 -05004646 */
Alex Elderc0fba362013-04-25 23:15:08 -05004647 if (rbd_dev->spec->image_id) {
4648 rbd_dev->image_format = *rbd_dev->spec->image_id ? 2 : 1;
4649
Alex Elder2c0d0a12012-10-30 19:40:33 -05004650 return 0;
Alex Elderc0fba362013-04-25 23:15:08 -05004651 }
Alex Elder2c0d0a12012-10-30 19:40:33 -05004652
4653 /*
Alex Elder589d30e2012-07-10 20:30:11 -05004654 * First, see if the format 2 image id file exists, and if
4655 * so, get the image's persistent id from it.
4656 */
Alex Elder69e7a022012-11-01 08:39:26 -05004657 size = sizeof (RBD_ID_PREFIX) + strlen(rbd_dev->spec->image_name);
Alex Elder589d30e2012-07-10 20:30:11 -05004658 object_name = kmalloc(size, GFP_NOIO);
4659 if (!object_name)
4660 return -ENOMEM;
Alex Elder0d7dbfc2012-10-25 23:34:41 -05004661 sprintf(object_name, "%s%s", RBD_ID_PREFIX, rbd_dev->spec->image_name);
Alex Elder589d30e2012-07-10 20:30:11 -05004662 dout("rbd id object name is %s\n", object_name);
4663
4664 /* Response will be an encoded string, which includes a length */
4665
4666 size = sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX;
4667 response = kzalloc(size, GFP_NOIO);
4668 if (!response) {
4669 ret = -ENOMEM;
4670 goto out;
4671 }
4672
Alex Elderc0fba362013-04-25 23:15:08 -05004673 /* If it doesn't exist we'll assume it's a format 1 image */
4674
Alex Elder36be9a72013-01-19 00:30:28 -06004675 ret = rbd_obj_method_sync(rbd_dev, object_name,
Alex Elder41579762013-04-21 12:14:45 -05004676 "rbd", "get_id", NULL, 0,
Alex Eldere2a58ee2013-04-30 00:44:33 -05004677 response, RBD_IMAGE_ID_LEN_MAX);
Alex Elder36be9a72013-01-19 00:30:28 -06004678 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elderc0fba362013-04-25 23:15:08 -05004679 if (ret == -ENOENT) {
4680 image_id = kstrdup("", GFP_KERNEL);
4681 ret = image_id ? 0 : -ENOMEM;
4682 if (!ret)
4683 rbd_dev->image_format = 1;
4684 } else if (ret > sizeof (__le32)) {
4685 void *p = response;
Alex Elder589d30e2012-07-10 20:30:11 -05004686
Alex Elderc0fba362013-04-25 23:15:08 -05004687 image_id = ceph_extract_encoded_string(&p, p + ret,
Alex Elder979ed482012-11-01 08:39:26 -05004688 NULL, GFP_NOIO);
Alex Elderc0fba362013-04-25 23:15:08 -05004689 ret = IS_ERR(image_id) ? PTR_ERR(image_id) : 0;
4690 if (!ret)
4691 rbd_dev->image_format = 2;
Alex Elder589d30e2012-07-10 20:30:11 -05004692 } else {
Alex Elderc0fba362013-04-25 23:15:08 -05004693 ret = -EINVAL;
4694 }
4695
4696 if (!ret) {
4697 rbd_dev->spec->image_id = image_id;
4698 dout("image_id is %s\n", image_id);
Alex Elder589d30e2012-07-10 20:30:11 -05004699 }
4700out:
4701 kfree(response);
4702 kfree(object_name);
4703
4704 return ret;
4705}
4706
Alex Elder3abef3b2013-05-13 20:35:37 -05004707/*
4708 * Undo whatever state changes are made by v1 or v2 header info
4709 * call.
4710 */
Alex Elder6fd48b32013-04-28 23:32:34 -05004711static void rbd_dev_unprobe(struct rbd_device *rbd_dev)
4712{
4713 struct rbd_image_header *header;
4714
Alex Elder392a9da2013-05-06 17:40:33 -05004715 /* Drop parent reference unless it's already been done (or none) */
4716
4717 if (rbd_dev->parent_overlap)
4718 rbd_dev_parent_put(rbd_dev);
Alex Elder6fd48b32013-04-28 23:32:34 -05004719
4720 /* Free dynamic fields from the header, then zero it out */
4721
4722 header = &rbd_dev->header;
Alex Elder812164f82013-04-30 00:44:32 -05004723 ceph_put_snap_context(header->snapc);
Alex Elder6fd48b32013-04-28 23:32:34 -05004724 kfree(header->snap_sizes);
4725 kfree(header->snap_names);
4726 kfree(header->object_prefix);
4727 memset(header, 0, sizeof (*header));
4728}
4729
Alex Elder2df3fac2013-05-06 09:51:30 -05004730static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev)
Alex Eldera30b71b2012-07-10 20:30:11 -05004731{
Alex Elder9d475de2012-07-03 16:01:19 -05004732 int ret;
Alex Eldera30b71b2012-07-10 20:30:11 -05004733
Alex Elder1e130192012-07-03 16:01:19 -05004734 ret = rbd_dev_v2_object_prefix(rbd_dev);
Alex Elder57385b52013-04-21 12:14:45 -05004735 if (ret)
Alex Elder1e130192012-07-03 16:01:19 -05004736 goto out_err;
Alex Elderb1b54022012-07-03 16:01:19 -05004737
Alex Elder2df3fac2013-05-06 09:51:30 -05004738 /*
4739 * Get the and check features for the image. Currently the
4740 * features are assumed to never change.
4741 */
Alex Elderb1b54022012-07-03 16:01:19 -05004742 ret = rbd_dev_v2_features(rbd_dev);
Alex Elder57385b52013-04-21 12:14:45 -05004743 if (ret)
Alex Elderb1b54022012-07-03 16:01:19 -05004744 goto out_err;
Alex Elder35d489f2012-07-03 16:01:19 -05004745
Alex Eldercc070d52013-04-21 12:14:45 -05004746 /* If the image supports fancy striping, get its parameters */
4747
4748 if (rbd_dev->header.features & RBD_FEATURE_STRIPINGV2) {
4749 ret = rbd_dev_v2_striping_info(rbd_dev);
4750 if (ret < 0)
4751 goto out_err;
4752 }
Alex Elder2df3fac2013-05-06 09:51:30 -05004753 /* No support for crypto and compression type format 2 images */
Alex Elder6e14b1a2012-07-03 16:01:19 -05004754
Alex Elder35152972012-08-31 17:29:55 -05004755 return 0;
Alex Elder9d475de2012-07-03 16:01:19 -05004756out_err:
Alex Elder642a2532013-05-06 17:40:33 -05004757 rbd_dev->header.features = 0;
Alex Elder1e130192012-07-03 16:01:19 -05004758 kfree(rbd_dev->header.object_prefix);
4759 rbd_dev->header.object_prefix = NULL;
Alex Elder9d475de2012-07-03 16:01:19 -05004760
4761 return ret;
Alex Eldera30b71b2012-07-10 20:30:11 -05004762}
4763
Alex Elder124afba2013-04-26 15:44:36 -05004764static int rbd_dev_probe_parent(struct rbd_device *rbd_dev)
Alex Elder83a06262012-10-30 15:47:17 -05004765{
Alex Elder2f82ee52012-10-30 19:40:33 -05004766 struct rbd_device *parent = NULL;
Alex Elder124afba2013-04-26 15:44:36 -05004767 struct rbd_spec *parent_spec;
4768 struct rbd_client *rbdc;
4769 int ret;
4770
4771 if (!rbd_dev->parent_spec)
4772 return 0;
4773 /*
4774 * We need to pass a reference to the client and the parent
4775 * spec when creating the parent rbd_dev. Images related by
4776 * parent/child relationships always share both.
4777 */
4778 parent_spec = rbd_spec_get(rbd_dev->parent_spec);
4779 rbdc = __rbd_get_client(rbd_dev->rbd_client);
4780
4781 ret = -ENOMEM;
4782 parent = rbd_dev_create(rbdc, parent_spec);
4783 if (!parent)
4784 goto out_err;
4785
Alex Elder1f3ef782013-05-06 17:40:33 -05004786 ret = rbd_dev_image_probe(parent, false);
Alex Elder124afba2013-04-26 15:44:36 -05004787 if (ret < 0)
4788 goto out_err;
4789 rbd_dev->parent = parent;
Alex Eldera2acd002013-05-08 22:50:04 -05004790 atomic_set(&rbd_dev->parent_ref, 1);
Alex Elder124afba2013-04-26 15:44:36 -05004791
4792 return 0;
4793out_err:
4794 if (parent) {
Alex Elderfb65d2282013-05-08 22:50:04 -05004795 rbd_dev_unparent(rbd_dev);
Alex Elder124afba2013-04-26 15:44:36 -05004796 kfree(rbd_dev->header_name);
4797 rbd_dev_destroy(parent);
4798 } else {
4799 rbd_put_client(rbdc);
4800 rbd_spec_put(parent_spec);
4801 }
4802
4803 return ret;
4804}
4805
Alex Elder200a6a82013-04-28 23:32:34 -05004806static int rbd_dev_device_setup(struct rbd_device *rbd_dev)
Alex Elder124afba2013-04-26 15:44:36 -05004807{
Alex Elder83a06262012-10-30 15:47:17 -05004808 int ret;
Alex Elder83a06262012-10-30 15:47:17 -05004809
Alex Elder83a06262012-10-30 15:47:17 -05004810 /* generate unique id: find highest unique id, add one */
4811 rbd_dev_id_get(rbd_dev);
4812
4813 /* Fill in the device name, now that we have its id. */
4814 BUILD_BUG_ON(DEV_NAME_LEN
4815 < sizeof (RBD_DRV_NAME) + MAX_INT_FORMAT_WIDTH);
4816 sprintf(rbd_dev->name, "%s%d", RBD_DRV_NAME, rbd_dev->dev_id);
4817
4818 /* Get our block major device number. */
4819
4820 ret = register_blkdev(0, rbd_dev->name);
4821 if (ret < 0)
4822 goto err_out_id;
4823 rbd_dev->major = ret;
4824
4825 /* Set up the blkdev mapping. */
4826
4827 ret = rbd_init_disk(rbd_dev);
4828 if (ret)
4829 goto err_out_blkdev;
4830
Alex Elderf35a4de2013-05-06 09:51:29 -05004831 ret = rbd_dev_mapping_set(rbd_dev);
Alex Elder83a06262012-10-30 15:47:17 -05004832 if (ret)
4833 goto err_out_disk;
Alex Elderf35a4de2013-05-06 09:51:29 -05004834 set_capacity(rbd_dev->disk, rbd_dev->mapping.size / SECTOR_SIZE);
4835
4836 ret = rbd_bus_add_dev(rbd_dev);
4837 if (ret)
4838 goto err_out_mapping;
Alex Elder83a06262012-10-30 15:47:17 -05004839
Alex Elder83a06262012-10-30 15:47:17 -05004840 /* Everything's ready. Announce the disk to the world. */
4841
Alex Elder129b79d2013-04-26 15:44:36 -05004842 set_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
Alex Elder83a06262012-10-30 15:47:17 -05004843 add_disk(rbd_dev->disk);
4844
4845 pr_info("%s: added with size 0x%llx\n", rbd_dev->disk->disk_name,
4846 (unsigned long long) rbd_dev->mapping.size);
4847
4848 return ret;
Alex Elder2f82ee52012-10-30 19:40:33 -05004849
Alex Elderf35a4de2013-05-06 09:51:29 -05004850err_out_mapping:
4851 rbd_dev_mapping_clear(rbd_dev);
Alex Elder83a06262012-10-30 15:47:17 -05004852err_out_disk:
4853 rbd_free_disk(rbd_dev);
4854err_out_blkdev:
4855 unregister_blkdev(rbd_dev->major, rbd_dev->name);
4856err_out_id:
4857 rbd_dev_id_put(rbd_dev);
Alex Elderd1cf5782013-04-27 09:59:30 -05004858 rbd_dev_mapping_clear(rbd_dev);
Alex Elder83a06262012-10-30 15:47:17 -05004859
4860 return ret;
4861}
4862
Alex Elder332bb122013-04-27 09:59:30 -05004863static int rbd_dev_header_name(struct rbd_device *rbd_dev)
4864{
4865 struct rbd_spec *spec = rbd_dev->spec;
4866 size_t size;
4867
4868 /* Record the header object name for this rbd image. */
4869
4870 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
4871
4872 if (rbd_dev->image_format == 1)
4873 size = strlen(spec->image_name) + sizeof (RBD_SUFFIX);
4874 else
4875 size = sizeof (RBD_HEADER_PREFIX) + strlen(spec->image_id);
4876
4877 rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
4878 if (!rbd_dev->header_name)
4879 return -ENOMEM;
4880
4881 if (rbd_dev->image_format == 1)
4882 sprintf(rbd_dev->header_name, "%s%s",
4883 spec->image_name, RBD_SUFFIX);
4884 else
4885 sprintf(rbd_dev->header_name, "%s%s",
4886 RBD_HEADER_PREFIX, spec->image_id);
4887 return 0;
4888}
4889
Alex Elder200a6a82013-04-28 23:32:34 -05004890static void rbd_dev_image_release(struct rbd_device *rbd_dev)
4891{
Alex Elder6fd48b32013-04-28 23:32:34 -05004892 rbd_dev_unprobe(rbd_dev);
Alex Elder200a6a82013-04-28 23:32:34 -05004893 kfree(rbd_dev->header_name);
Alex Elder6fd48b32013-04-28 23:32:34 -05004894 rbd_dev->header_name = NULL;
4895 rbd_dev->image_format = 0;
4896 kfree(rbd_dev->spec->image_id);
4897 rbd_dev->spec->image_id = NULL;
4898
Alex Elder200a6a82013-04-28 23:32:34 -05004899 rbd_dev_destroy(rbd_dev);
4900}
4901
Alex Eldera30b71b2012-07-10 20:30:11 -05004902/*
4903 * Probe for the existence of the header object for the given rbd
Alex Elder1f3ef782013-05-06 17:40:33 -05004904 * device. If this image is the one being mapped (i.e., not a
4905 * parent), initiate a watch on its header object before using that
4906 * object to get detailed information about the rbd image.
Alex Eldera30b71b2012-07-10 20:30:11 -05004907 */
Alex Elder1f3ef782013-05-06 17:40:33 -05004908static int rbd_dev_image_probe(struct rbd_device *rbd_dev, bool mapping)
Alex Eldera30b71b2012-07-10 20:30:11 -05004909{
4910 int ret;
Alex Elderb644de22013-04-27 09:59:31 -05004911 int tmp;
Alex Eldera30b71b2012-07-10 20:30:11 -05004912
4913 /*
Alex Elder3abef3b2013-05-13 20:35:37 -05004914 * Get the id from the image id object. Unless there's an
4915 * error, rbd_dev->spec->image_id will be filled in with
4916 * a dynamically-allocated string, and rbd_dev->image_format
4917 * will be set to either 1 or 2.
Alex Eldera30b71b2012-07-10 20:30:11 -05004918 */
4919 ret = rbd_dev_image_id(rbd_dev);
4920 if (ret)
Alex Elderc0fba362013-04-25 23:15:08 -05004921 return ret;
4922 rbd_assert(rbd_dev->spec->image_id);
4923 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
4924
Alex Elder332bb122013-04-27 09:59:30 -05004925 ret = rbd_dev_header_name(rbd_dev);
4926 if (ret)
4927 goto err_out_format;
4928
Alex Elder1f3ef782013-05-06 17:40:33 -05004929 if (mapping) {
4930 ret = rbd_dev_header_watch_sync(rbd_dev, true);
4931 if (ret)
4932 goto out_header_name;
4933 }
Alex Elderb644de22013-04-27 09:59:31 -05004934
Alex Elderc0fba362013-04-25 23:15:08 -05004935 if (rbd_dev->image_format == 1)
Alex Elder99a41eb2013-05-06 09:51:30 -05004936 ret = rbd_dev_v1_header_info(rbd_dev);
Alex Eldera30b71b2012-07-10 20:30:11 -05004937 else
Alex Elder2df3fac2013-05-06 09:51:30 -05004938 ret = rbd_dev_v2_header_info(rbd_dev);
Alex Elder5655c4d2013-04-25 23:15:08 -05004939 if (ret)
Alex Elderb644de22013-04-27 09:59:31 -05004940 goto err_out_watch;
Alex Elder83a06262012-10-30 15:47:17 -05004941
Alex Elder9bb81c92013-04-27 09:59:30 -05004942 ret = rbd_dev_spec_update(rbd_dev);
4943 if (ret)
Alex Elder33dca392013-04-30 00:44:33 -05004944 goto err_out_probe;
Alex Elder9bb81c92013-04-27 09:59:30 -05004945
4946 ret = rbd_dev_probe_parent(rbd_dev);
Alex Elder30d60ba2013-05-06 09:51:30 -05004947 if (ret)
4948 goto err_out_probe;
Alex Elder83a06262012-10-30 15:47:17 -05004949
Alex Elder30d60ba2013-05-06 09:51:30 -05004950 dout("discovered format %u image, header name is %s\n",
4951 rbd_dev->image_format, rbd_dev->header_name);
4952
4953 return 0;
Alex Elder6fd48b32013-04-28 23:32:34 -05004954err_out_probe:
4955 rbd_dev_unprobe(rbd_dev);
Alex Elderb644de22013-04-27 09:59:31 -05004956err_out_watch:
Alex Elder1f3ef782013-05-06 17:40:33 -05004957 if (mapping) {
4958 tmp = rbd_dev_header_watch_sync(rbd_dev, false);
4959 if (tmp)
4960 rbd_warn(rbd_dev, "unable to tear down "
4961 "watch request (%d)\n", tmp);
4962 }
Alex Elder332bb122013-04-27 09:59:30 -05004963out_header_name:
4964 kfree(rbd_dev->header_name);
4965 rbd_dev->header_name = NULL;
4966err_out_format:
4967 rbd_dev->image_format = 0;
Alex Elder5655c4d2013-04-25 23:15:08 -05004968 kfree(rbd_dev->spec->image_id);
4969 rbd_dev->spec->image_id = NULL;
4970
4971 dout("probe failed, returning %d\n", ret);
4972
4973 return ret;
Alex Eldera30b71b2012-07-10 20:30:11 -05004974}
4975
Yehuda Sadeh59c2be12011-03-21 15:10:11 -07004976static ssize_t rbd_add(struct bus_type *bus,
4977 const char *buf,
4978 size_t count)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004979{
Alex Eldercb8627c2012-07-09 21:04:23 -05004980 struct rbd_device *rbd_dev = NULL;
Alex Elderdc79b112012-10-25 23:34:41 -05004981 struct ceph_options *ceph_opts = NULL;
Alex Elder4e9afeb2012-10-25 23:34:41 -05004982 struct rbd_options *rbd_opts = NULL;
Alex Elder859c31d2012-10-25 23:34:42 -05004983 struct rbd_spec *spec = NULL;
Alex Elder9d3997f2012-10-25 23:34:42 -05004984 struct rbd_client *rbdc;
Alex Elder27cc2592012-02-02 08:13:30 -06004985 struct ceph_osd_client *osdc;
Alex Elder51344a32013-05-06 07:40:30 -05004986 bool read_only;
Alex Elder27cc2592012-02-02 08:13:30 -06004987 int rc = -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004988
4989 if (!try_module_get(THIS_MODULE))
4990 return -ENODEV;
4991
Alex Eldera725f65e2012-02-02 08:13:30 -06004992 /* parse add command */
Alex Elder859c31d2012-10-25 23:34:42 -05004993 rc = rbd_add_parse_args(buf, &ceph_opts, &rbd_opts, &spec);
Alex Elderdc79b112012-10-25 23:34:41 -05004994 if (rc < 0)
Alex Elderbd4ba652012-10-25 23:34:42 -05004995 goto err_out_module;
Alex Elder51344a32013-05-06 07:40:30 -05004996 read_only = rbd_opts->read_only;
4997 kfree(rbd_opts);
4998 rbd_opts = NULL; /* done with this */
Alex Eldera725f65e2012-02-02 08:13:30 -06004999
Alex Elder9d3997f2012-10-25 23:34:42 -05005000 rbdc = rbd_get_client(ceph_opts);
5001 if (IS_ERR(rbdc)) {
5002 rc = PTR_ERR(rbdc);
Alex Elder0ddebc02012-10-25 23:34:41 -05005003 goto err_out_args;
Alex Elder9d3997f2012-10-25 23:34:42 -05005004 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005005
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005006 /* pick the pool */
Alex Elder9d3997f2012-10-25 23:34:42 -05005007 osdc = &rbdc->client->osdc;
Alex Elder859c31d2012-10-25 23:34:42 -05005008 rc = ceph_pg_poolid_by_name(osdc->osdmap, spec->pool_name);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005009 if (rc < 0)
5010 goto err_out_client;
Alex Elderc0cd10db2013-04-26 09:43:47 -05005011 spec->pool_id = (u64)rc;
Alex Elder859c31d2012-10-25 23:34:42 -05005012
Alex Elder0903e872012-11-14 12:25:19 -06005013 /* The ceph file layout needs to fit pool id in 32 bits */
5014
Alex Elderc0cd10db2013-04-26 09:43:47 -05005015 if (spec->pool_id > (u64)U32_MAX) {
5016 rbd_warn(NULL, "pool id too large (%llu > %u)\n",
5017 (unsigned long long)spec->pool_id, U32_MAX);
Alex Elder0903e872012-11-14 12:25:19 -06005018 rc = -EIO;
5019 goto err_out_client;
5020 }
5021
Alex Elderc53d5892012-10-25 23:34:42 -05005022 rbd_dev = rbd_dev_create(rbdc, spec);
Alex Elderbd4ba652012-10-25 23:34:42 -05005023 if (!rbd_dev)
5024 goto err_out_client;
Alex Elderc53d5892012-10-25 23:34:42 -05005025 rbdc = NULL; /* rbd_dev now owns this */
5026 spec = NULL; /* rbd_dev now owns this */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005027
Alex Elder1f3ef782013-05-06 17:40:33 -05005028 rc = rbd_dev_image_probe(rbd_dev, true);
Alex Eldera30b71b2012-07-10 20:30:11 -05005029 if (rc < 0)
Alex Elderc53d5892012-10-25 23:34:42 -05005030 goto err_out_rbd_dev;
Alex Elder05fd6f62012-08-29 17:11:07 -05005031
Alex Elder7ce4eef2013-05-06 17:40:33 -05005032 /* If we are mapping a snapshot it must be marked read-only */
5033
5034 if (rbd_dev->spec->snap_id != CEPH_NOSNAP)
5035 read_only = true;
5036 rbd_dev->mapping.read_only = read_only;
5037
Alex Elderb536f692013-04-28 23:32:34 -05005038 rc = rbd_dev_device_setup(rbd_dev);
Alex Elder3abef3b2013-05-13 20:35:37 -05005039 if (rc) {
5040 rbd_dev_image_release(rbd_dev);
5041 goto err_out_module;
5042 }
Alex Elderb536f692013-04-28 23:32:34 -05005043
Alex Elder3abef3b2013-05-13 20:35:37 -05005044 return count;
5045
Alex Elderc53d5892012-10-25 23:34:42 -05005046err_out_rbd_dev:
5047 rbd_dev_destroy(rbd_dev);
Alex Elderbd4ba652012-10-25 23:34:42 -05005048err_out_client:
Alex Elder9d3997f2012-10-25 23:34:42 -05005049 rbd_put_client(rbdc);
Alex Elder0ddebc02012-10-25 23:34:41 -05005050err_out_args:
Alex Elder859c31d2012-10-25 23:34:42 -05005051 rbd_spec_put(spec);
Alex Elderbd4ba652012-10-25 23:34:42 -05005052err_out_module:
5053 module_put(THIS_MODULE);
Alex Elder27cc2592012-02-02 08:13:30 -06005054
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005055 dout("Error adding device %s\n", buf);
Alex Elder27cc2592012-02-02 08:13:30 -06005056
Alex Elderc0cd10db2013-04-26 09:43:47 -05005057 return (ssize_t)rc;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005058}
5059
Alex Elderde71a292012-07-03 16:01:19 -05005060static struct rbd_device *__rbd_get_dev(unsigned long dev_id)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005061{
5062 struct list_head *tmp;
5063 struct rbd_device *rbd_dev;
5064
Alex Eldere124a82f2012-01-29 13:57:44 -06005065 spin_lock(&rbd_dev_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005066 list_for_each(tmp, &rbd_dev_list) {
5067 rbd_dev = list_entry(tmp, struct rbd_device, node);
Alex Elderde71a292012-07-03 16:01:19 -05005068 if (rbd_dev->dev_id == dev_id) {
Alex Eldere124a82f2012-01-29 13:57:44 -06005069 spin_unlock(&rbd_dev_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005070 return rbd_dev;
Alex Eldere124a82f2012-01-29 13:57:44 -06005071 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005072 }
Alex Eldere124a82f2012-01-29 13:57:44 -06005073 spin_unlock(&rbd_dev_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005074 return NULL;
5075}
5076
Alex Elder200a6a82013-04-28 23:32:34 -05005077static void rbd_dev_device_release(struct device *dev)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005078{
Alex Elder593a9e72012-02-07 12:03:37 -06005079 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005080
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005081 rbd_free_disk(rbd_dev);
Alex Elder200a6a82013-04-28 23:32:34 -05005082 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
Alex Elder6d80b132013-05-06 07:40:30 -05005083 rbd_dev_mapping_clear(rbd_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005084 unregister_blkdev(rbd_dev->major, rbd_dev->name);
Alex Elder200a6a82013-04-28 23:32:34 -05005085 rbd_dev->major = 0;
Alex Eldere2839302012-08-29 17:11:06 -05005086 rbd_dev_id_put(rbd_dev);
Alex Elderd1cf5782013-04-27 09:59:30 -05005087 rbd_dev_mapping_clear(rbd_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005088}
5089
Alex Elder05a46af2013-04-26 15:44:36 -05005090static void rbd_dev_remove_parent(struct rbd_device *rbd_dev)
5091{
Alex Elderad945fc2013-04-26 15:44:36 -05005092 while (rbd_dev->parent) {
Alex Elder05a46af2013-04-26 15:44:36 -05005093 struct rbd_device *first = rbd_dev;
5094 struct rbd_device *second = first->parent;
5095 struct rbd_device *third;
5096
5097 /*
5098 * Follow to the parent with no grandparent and
5099 * remove it.
5100 */
5101 while (second && (third = second->parent)) {
5102 first = second;
5103 second = third;
5104 }
Alex Elderad945fc2013-04-26 15:44:36 -05005105 rbd_assert(second);
Alex Elder8ad42cd2013-04-28 23:32:34 -05005106 rbd_dev_image_release(second);
Alex Elderad945fc2013-04-26 15:44:36 -05005107 first->parent = NULL;
5108 first->parent_overlap = 0;
5109
5110 rbd_assert(first->parent_spec);
Alex Elder05a46af2013-04-26 15:44:36 -05005111 rbd_spec_put(first->parent_spec);
5112 first->parent_spec = NULL;
Alex Elder05a46af2013-04-26 15:44:36 -05005113 }
5114}
5115
Yehuda Sadehdfc56062010-11-19 14:51:04 -08005116static ssize_t rbd_remove(struct bus_type *bus,
5117 const char *buf,
5118 size_t count)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005119{
5120 struct rbd_device *rbd_dev = NULL;
Alex Elder0d8189e2013-04-27 09:59:30 -05005121 int target_id;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005122 unsigned long ul;
Alex Elder0d8189e2013-04-27 09:59:30 -05005123 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005124
Alex Elder0d8189e2013-04-27 09:59:30 -05005125 ret = strict_strtoul(buf, 10, &ul);
5126 if (ret)
5127 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005128
5129 /* convert to int; abort if we lost anything in the conversion */
5130 target_id = (int) ul;
5131 if (target_id != ul)
5132 return -EINVAL;
5133
5134 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
5135
5136 rbd_dev = __rbd_get_dev(target_id);
5137 if (!rbd_dev) {
5138 ret = -ENOENT;
5139 goto done;
5140 }
5141
Alex Eldera14ea262013-02-05 13:23:12 -06005142 spin_lock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -06005143 if (rbd_dev->open_count)
Alex Elder42382b72012-11-16 09:29:16 -06005144 ret = -EBUSY;
Alex Elderb82d1672013-01-14 12:43:31 -06005145 else
5146 set_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags);
Alex Eldera14ea262013-02-05 13:23:12 -06005147 spin_unlock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -06005148 if (ret < 0)
Alex Elder42382b72012-11-16 09:29:16 -06005149 goto done;
Alex Elderb4808152013-04-26 15:44:36 -05005150 rbd_bus_del_dev(rbd_dev);
Alex Elder1f3ef782013-05-06 17:40:33 -05005151 ret = rbd_dev_header_watch_sync(rbd_dev, false);
5152 if (ret)
5153 rbd_warn(rbd_dev, "failed to cancel watch event (%d)\n", ret);
Alex Elder8ad42cd2013-04-28 23:32:34 -05005154 rbd_dev_image_release(rbd_dev);
Alex Elder79ab7552013-04-28 23:32:34 -05005155 module_put(THIS_MODULE);
Alex Elder1f3ef782013-05-06 17:40:33 -05005156 ret = count;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005157done:
5158 mutex_unlock(&ctl_mutex);
Alex Elderaafb2302012-09-06 16:00:54 -05005159
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005160 return ret;
5161}
5162
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005163/*
5164 * create control files in sysfs
Yehuda Sadehdfc56062010-11-19 14:51:04 -08005165 * /sys/bus/rbd/...
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005166 */
5167static int rbd_sysfs_init(void)
5168{
Yehuda Sadehdfc56062010-11-19 14:51:04 -08005169 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005170
Alex Elderfed4c142012-02-07 12:03:36 -06005171 ret = device_register(&rbd_root_dev);
Alex Elder21079782012-01-24 10:08:36 -06005172 if (ret < 0)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08005173 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005174
Alex Elderfed4c142012-02-07 12:03:36 -06005175 ret = bus_register(&rbd_bus_type);
5176 if (ret < 0)
5177 device_unregister(&rbd_root_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005178
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005179 return ret;
5180}
5181
5182static void rbd_sysfs_cleanup(void)
5183{
Yehuda Sadehdfc56062010-11-19 14:51:04 -08005184 bus_unregister(&rbd_bus_type);
Alex Elderfed4c142012-02-07 12:03:36 -06005185 device_unregister(&rbd_root_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005186}
5187
Alex Elder1c2a9df2013-05-01 12:43:03 -05005188static int rbd_slab_init(void)
5189{
5190 rbd_assert(!rbd_img_request_cache);
5191 rbd_img_request_cache = kmem_cache_create("rbd_img_request",
5192 sizeof (struct rbd_img_request),
5193 __alignof__(struct rbd_img_request),
5194 0, NULL);
Alex Elder868311b2013-05-01 12:43:03 -05005195 if (!rbd_img_request_cache)
5196 return -ENOMEM;
5197
5198 rbd_assert(!rbd_obj_request_cache);
5199 rbd_obj_request_cache = kmem_cache_create("rbd_obj_request",
5200 sizeof (struct rbd_obj_request),
5201 __alignof__(struct rbd_obj_request),
5202 0, NULL);
Alex Elder78c2a442013-05-01 12:43:04 -05005203 if (!rbd_obj_request_cache)
5204 goto out_err;
5205
5206 rbd_assert(!rbd_segment_name_cache);
5207 rbd_segment_name_cache = kmem_cache_create("rbd_segment_name",
5208 MAX_OBJ_NAME_SIZE + 1, 1, 0, NULL);
5209 if (rbd_segment_name_cache)
Alex Elder1c2a9df2013-05-01 12:43:03 -05005210 return 0;
Alex Elder78c2a442013-05-01 12:43:04 -05005211out_err:
5212 if (rbd_obj_request_cache) {
5213 kmem_cache_destroy(rbd_obj_request_cache);
5214 rbd_obj_request_cache = NULL;
5215 }
Alex Elder1c2a9df2013-05-01 12:43:03 -05005216
Alex Elder868311b2013-05-01 12:43:03 -05005217 kmem_cache_destroy(rbd_img_request_cache);
5218 rbd_img_request_cache = NULL;
5219
Alex Elder1c2a9df2013-05-01 12:43:03 -05005220 return -ENOMEM;
5221}
5222
5223static void rbd_slab_exit(void)
5224{
Alex Elder78c2a442013-05-01 12:43:04 -05005225 rbd_assert(rbd_segment_name_cache);
5226 kmem_cache_destroy(rbd_segment_name_cache);
5227 rbd_segment_name_cache = NULL;
5228
Alex Elder868311b2013-05-01 12:43:03 -05005229 rbd_assert(rbd_obj_request_cache);
5230 kmem_cache_destroy(rbd_obj_request_cache);
5231 rbd_obj_request_cache = NULL;
5232
Alex Elder1c2a9df2013-05-01 12:43:03 -05005233 rbd_assert(rbd_img_request_cache);
5234 kmem_cache_destroy(rbd_img_request_cache);
5235 rbd_img_request_cache = NULL;
5236}
5237
Alex Eldercc344fa2013-02-19 12:25:56 -06005238static int __init rbd_init(void)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005239{
5240 int rc;
5241
Alex Elder1e32d342013-01-30 11:13:33 -06005242 if (!libceph_compatible(NULL)) {
5243 rbd_warn(NULL, "libceph incompatibility (quitting)");
5244
5245 return -EINVAL;
5246 }
Alex Elder1c2a9df2013-05-01 12:43:03 -05005247 rc = rbd_slab_init();
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005248 if (rc)
5249 return rc;
Alex Elder1c2a9df2013-05-01 12:43:03 -05005250 rc = rbd_sysfs_init();
5251 if (rc)
5252 rbd_slab_exit();
5253 else
5254 pr_info("loaded " RBD_DRV_NAME_LONG "\n");
5255
5256 return rc;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005257}
5258
Alex Eldercc344fa2013-02-19 12:25:56 -06005259static void __exit rbd_exit(void)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005260{
5261 rbd_sysfs_cleanup();
Alex Elder1c2a9df2013-05-01 12:43:03 -05005262 rbd_slab_exit();
Yehuda Sadeh602adf42010-08-12 16:11:25 -07005263}
5264
5265module_init(rbd_init);
5266module_exit(rbd_exit);
5267
5268MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
5269MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
5270MODULE_DESCRIPTION("rados block device");
5271
5272/* following authorship retained from original osdblk.c */
5273MODULE_AUTHOR("Jeff Garzik <jeff@garzik.org>");
5274
5275MODULE_LICENSE("GPL");