blob: 3cc003b2661079605cda408d4153d9e808b1155b [file] [log] [blame]
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001/*
2 rbd.c -- Export ceph rados objects as a Linux block device
3
4
5 based on drivers/block/osdblk.c:
6
7 Copyright 2009 Red Hat, Inc.
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program; see the file COPYING. If not, write to
20 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
21
22
23
Yehuda Sadehdfc56062010-11-19 14:51:04 -080024 For usage instructions, please refer to:
Yehuda Sadeh602adf42010-08-12 16:11:25 -070025
Yehuda Sadehdfc56062010-11-19 14:51:04 -080026 Documentation/ABI/testing/sysfs-bus-rbd
Yehuda Sadeh602adf42010-08-12 16:11:25 -070027
28 */
29
30#include <linux/ceph/libceph.h>
31#include <linux/ceph/osd_client.h>
32#include <linux/ceph/mon_client.h>
33#include <linux/ceph/decode.h>
Yehuda Sadeh59c2be12011-03-21 15:10:11 -070034#include <linux/parser.h>
Yehuda Sadeh602adf42010-08-12 16:11:25 -070035
36#include <linux/kernel.h>
37#include <linux/device.h>
38#include <linux/module.h>
39#include <linux/fs.h>
40#include <linux/blkdev.h>
41
42#include "rbd_types.h"
43
Alex Elderaafb2302012-09-06 16:00:54 -050044#define RBD_DEBUG /* Activate rbd_assert() calls */
45
Alex Elder593a9e72012-02-07 12:03:37 -060046/*
47 * The basic unit of block I/O is a sector. It is interpreted in a
48 * number of contexts in Linux (blk, bio, genhd), but the default is
49 * universally 512 bytes. These symbols are just slightly more
50 * meaningful than the bare numbers they represent.
51 */
52#define SECTOR_SHIFT 9
53#define SECTOR_SIZE (1ULL << SECTOR_SHIFT)
54
Alex Elder2647ba32012-11-19 22:55:21 -060055/* It might be useful to have these defined elsewhere */
Alex Elderdf111be2012-08-09 10:33:26 -070056
Alex Elder2647ba32012-11-19 22:55:21 -060057#define U8_MAX ((u8) (~0U))
58#define U16_MAX ((u16) (~0U))
59#define U32_MAX ((u32) (~0U))
60#define U64_MAX ((u64) (~0ULL))
Alex Elderdf111be2012-08-09 10:33:26 -070061
Alex Elderf0f8cef2012-01-29 13:57:44 -060062#define RBD_DRV_NAME "rbd"
63#define RBD_DRV_NAME_LONG "rbd (rados block device)"
Yehuda Sadeh602adf42010-08-12 16:11:25 -070064
65#define RBD_MINORS_PER_MAJOR 256 /* max minors per blkdev */
66
Alex Elderd4b125e2012-07-03 16:01:19 -050067#define RBD_SNAP_DEV_NAME_PREFIX "snap_"
68#define RBD_MAX_SNAP_NAME_LEN \
69 (NAME_MAX - (sizeof (RBD_SNAP_DEV_NAME_PREFIX) - 1))
70
Alex Elder35d489f2012-07-03 16:01:19 -050071#define RBD_MAX_SNAP_COUNT 510 /* allows max snapc to fit in 4KB */
Yehuda Sadeh602adf42010-08-12 16:11:25 -070072
73#define RBD_SNAP_HEAD_NAME "-"
74
Alex Elder9e15b772012-10-30 19:40:33 -050075/* This allows a single page to hold an image name sent by OSD */
76#define RBD_IMAGE_NAME_LEN_MAX (PAGE_SIZE - sizeof (__le32) - 1)
Alex Elder1e130192012-07-03 16:01:19 -050077#define RBD_IMAGE_ID_LEN_MAX 64
Alex Elder9e15b772012-10-30 19:40:33 -050078
Alex Elder1e130192012-07-03 16:01:19 -050079#define RBD_OBJ_PREFIX_LEN_MAX 64
Alex Elder589d30e2012-07-10 20:30:11 -050080
Alex Elderd8891402012-10-09 13:50:17 -070081/* Feature bits */
82
83#define RBD_FEATURE_LAYERING 1
84
85/* Features supported by this (client software) implementation. */
86
87#define RBD_FEATURES_ALL (0)
88
Alex Elder81a89792012-02-02 08:13:30 -060089/*
90 * An RBD device name will be "rbd#", where the "rbd" comes from
91 * RBD_DRV_NAME above, and # is a unique integer identifier.
92 * MAX_INT_FORMAT_WIDTH is used in ensuring DEV_NAME_LEN is big
93 * enough to hold all possible device names.
94 */
Yehuda Sadeh602adf42010-08-12 16:11:25 -070095#define DEV_NAME_LEN 32
Alex Elder81a89792012-02-02 08:13:30 -060096#define MAX_INT_FORMAT_WIDTH ((5 * sizeof (int)) / 2 + 1)
Yehuda Sadeh602adf42010-08-12 16:11:25 -070097
98/*
99 * block device image metadata (in-memory version)
100 */
101struct rbd_image_header {
Alex Elderf84344f2012-08-31 17:29:51 -0500102 /* These four fields never change for a given rbd image */
Alex Elder849b4262012-07-09 21:04:24 -0500103 char *object_prefix;
Alex Elder34b13182012-07-13 20:35:12 -0500104 u64 features;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700105 __u8 obj_order;
106 __u8 crypt_type;
107 __u8 comp_type;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700108
Alex Elderf84344f2012-08-31 17:29:51 -0500109 /* The remaining fields need to be updated occasionally */
110 u64 image_size;
111 struct ceph_snap_context *snapc;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700112 char *snap_names;
113 u64 *snap_sizes;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700114
115 u64 obj_version;
116};
117
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500118/*
119 * An rbd image specification.
120 *
121 * The tuple (pool_id, image_id, snap_id) is sufficient to uniquely
Alex Elderc66c6e02012-11-01 08:39:26 -0500122 * identify an image. Each rbd_dev structure includes a pointer to
123 * an rbd_spec structure that encapsulates this identity.
124 *
125 * Each of the id's in an rbd_spec has an associated name. For a
126 * user-mapped image, the names are supplied and the id's associated
127 * with them are looked up. For a layered image, a parent image is
128 * defined by the tuple, and the names are looked up.
129 *
130 * An rbd_dev structure contains a parent_spec pointer which is
131 * non-null if the image it represents is a child in a layered
132 * image. This pointer will refer to the rbd_spec structure used
133 * by the parent rbd_dev for its own identity (i.e., the structure
134 * is shared between the parent and child).
135 *
136 * Since these structures are populated once, during the discovery
137 * phase of image construction, they are effectively immutable so
138 * we make no effort to synchronize access to them.
139 *
140 * Note that code herein does not assume the image name is known (it
141 * could be a null pointer).
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500142 */
143struct rbd_spec {
144 u64 pool_id;
145 char *pool_name;
146
147 char *image_id;
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500148 char *image_name;
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500149
150 u64 snap_id;
151 char *snap_name;
152
153 struct kref kref;
154};
155
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700156/*
Alex Elderf0f8cef2012-01-29 13:57:44 -0600157 * an instance of the client. multiple devices may share an rbd client.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700158 */
159struct rbd_client {
160 struct ceph_client *client;
161 struct kref kref;
162 struct list_head node;
163};
164
Alex Elderbf0d5f502012-11-22 00:00:08 -0600165struct rbd_img_request;
166typedef void (*rbd_img_callback_t)(struct rbd_img_request *);
167
168#define BAD_WHICH U32_MAX /* Good which or bad which, which? */
169
170struct rbd_obj_request;
171typedef void (*rbd_obj_callback_t)(struct rbd_obj_request *);
172
Alex Elder9969ebc2013-01-18 12:31:10 -0600173enum obj_request_type {
174 OBJ_REQUEST_NODATA, OBJ_REQUEST_BIO, OBJ_REQUEST_PAGES
175};
Alex Elderbf0d5f502012-11-22 00:00:08 -0600176
177struct rbd_obj_request {
178 const char *object_name;
179 u64 offset; /* object start byte */
180 u64 length; /* bytes from offset */
181
182 struct rbd_img_request *img_request;
183 struct list_head links; /* img_request->obj_requests */
184 u32 which; /* posn image request list */
185
186 enum obj_request_type type;
Alex Elder788e2df2013-01-17 12:25:27 -0600187 union {
188 struct bio *bio_list;
189 struct {
190 struct page **pages;
191 u32 page_count;
192 };
193 };
Alex Elderbf0d5f502012-11-22 00:00:08 -0600194
195 struct ceph_osd_request *osd_req;
196
197 u64 xferred; /* bytes transferred */
198 u64 version;
199 s32 result;
200 atomic_t done;
201
202 rbd_obj_callback_t callback;
Alex Elder788e2df2013-01-17 12:25:27 -0600203 struct completion completion;
Alex Elderbf0d5f502012-11-22 00:00:08 -0600204
205 struct kref kref;
206};
207
208struct rbd_img_request {
209 struct request *rq;
210 struct rbd_device *rbd_dev;
211 u64 offset; /* starting image byte offset */
212 u64 length; /* byte count from offset */
213 bool write_request; /* false for read */
214 union {
215 struct ceph_snap_context *snapc; /* for writes */
216 u64 snap_id; /* for reads */
217 };
218 spinlock_t completion_lock;/* protects next_completion */
219 u32 next_completion;
220 rbd_img_callback_t callback;
221
222 u32 obj_request_count;
223 struct list_head obj_requests; /* rbd_obj_request structs */
224
225 struct kref kref;
226};
227
228#define for_each_obj_request(ireq, oreq) \
Alex Elderef06f4d2013-02-08 09:55:48 -0600229 list_for_each_entry(oreq, &(ireq)->obj_requests, links)
Alex Elderbf0d5f502012-11-22 00:00:08 -0600230#define for_each_obj_request_from(ireq, oreq) \
Alex Elderef06f4d2013-02-08 09:55:48 -0600231 list_for_each_entry_from(oreq, &(ireq)->obj_requests, links)
Alex Elderbf0d5f502012-11-22 00:00:08 -0600232#define for_each_obj_request_safe(ireq, oreq, n) \
Alex Elderef06f4d2013-02-08 09:55:48 -0600233 list_for_each_entry_safe_reverse(oreq, n, &(ireq)->obj_requests, links)
Alex Elderbf0d5f502012-11-22 00:00:08 -0600234
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800235struct rbd_snap {
236 struct device dev;
237 const char *name;
Josh Durgin35915382011-12-05 18:25:13 -0800238 u64 size;
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800239 struct list_head node;
240 u64 id;
Alex Elder34b13182012-07-13 20:35:12 -0500241 u64 features;
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800242};
243
Alex Elderf84344f2012-08-31 17:29:51 -0500244struct rbd_mapping {
Alex Elder99c1f082012-08-30 14:42:15 -0500245 u64 size;
Alex Elder34b13182012-07-13 20:35:12 -0500246 u64 features;
Alex Elderf84344f2012-08-31 17:29:51 -0500247 bool read_only;
248};
249
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700250/*
251 * a single device
252 */
253struct rbd_device {
Alex Elderde71a292012-07-03 16:01:19 -0500254 int dev_id; /* blkdev unique id */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700255
256 int major; /* blkdev assigned major */
257 struct gendisk *disk; /* blkdev's gendisk and rq */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700258
Alex Eldera30b71b2012-07-10 20:30:11 -0500259 u32 image_format; /* Either 1 or 2 */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700260 struct rbd_client *rbd_client;
261
262 char name[DEV_NAME_LEN]; /* blkdev name, e.g. rbd3 */
263
Alex Elderb82d1672013-01-14 12:43:31 -0600264 spinlock_t lock; /* queue, flags, open_count */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700265
266 struct rbd_image_header header;
Alex Elderb82d1672013-01-14 12:43:31 -0600267 unsigned long flags; /* possibly lock protected */
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500268 struct rbd_spec *spec;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700269
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500270 char *header_name;
Alex Elder971f8392012-10-25 23:34:41 -0500271
Alex Elder0903e872012-11-14 12:25:19 -0600272 struct ceph_file_layout layout;
273
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700274 struct ceph_osd_event *watch_event;
Alex Elder975241a2013-01-25 17:08:55 -0600275 struct rbd_obj_request *watch_request;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700276
Alex Elder86b00e02012-10-25 23:34:42 -0500277 struct rbd_spec *parent_spec;
278 u64 parent_overlap;
279
Josh Durginc6666012011-11-21 17:11:12 -0800280 /* protects updating the header */
281 struct rw_semaphore header_rwsem;
Alex Elderf84344f2012-08-31 17:29:51 -0500282
283 struct rbd_mapping mapping;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700284
285 struct list_head node;
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800286
287 /* list of snapshots */
288 struct list_head snaps;
289
290 /* sysfs related */
291 struct device dev;
Alex Elderb82d1672013-01-14 12:43:31 -0600292 unsigned long open_count; /* protected by lock */
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800293};
294
Alex Elderb82d1672013-01-14 12:43:31 -0600295/*
296 * Flag bits for rbd_dev->flags. If atomicity is required,
297 * rbd_dev->lock is used to protect access.
298 *
299 * Currently, only the "removing" flag (which is coupled with the
300 * "open_count" field) requires atomic access.
301 */
Alex Elder6d292902013-01-14 12:43:31 -0600302enum rbd_dev_flags {
303 RBD_DEV_FLAG_EXISTS, /* mapped snapshot has not been deleted */
Alex Elderb82d1672013-01-14 12:43:31 -0600304 RBD_DEV_FLAG_REMOVING, /* this mapping is being removed */
Alex Elder6d292902013-01-14 12:43:31 -0600305};
306
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700307static DEFINE_MUTEX(ctl_mutex); /* Serialize open/close/setup/teardown */
Alex Eldere124a822012-01-29 13:57:44 -0600308
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700309static LIST_HEAD(rbd_dev_list); /* devices */
Alex Eldere124a822012-01-29 13:57:44 -0600310static DEFINE_SPINLOCK(rbd_dev_list_lock);
311
Alex Elder432b8582012-01-29 13:57:44 -0600312static LIST_HEAD(rbd_client_list); /* clients */
313static DEFINE_SPINLOCK(rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700314
Alex Elder304f6802012-08-31 17:29:52 -0500315static int rbd_dev_snaps_update(struct rbd_device *rbd_dev);
316static int rbd_dev_snaps_register(struct rbd_device *rbd_dev);
317
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800318static void rbd_dev_release(struct device *dev);
Alex Elder41f38c22012-10-25 23:34:40 -0500319static void rbd_remove_snap_dev(struct rbd_snap *snap);
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800320
Alex Elderf0f8cef2012-01-29 13:57:44 -0600321static ssize_t rbd_add(struct bus_type *bus, const char *buf,
322 size_t count);
323static ssize_t rbd_remove(struct bus_type *bus, const char *buf,
324 size_t count);
325
326static struct bus_attribute rbd_bus_attrs[] = {
327 __ATTR(add, S_IWUSR, NULL, rbd_add),
328 __ATTR(remove, S_IWUSR, NULL, rbd_remove),
329 __ATTR_NULL
330};
331
332static struct bus_type rbd_bus_type = {
333 .name = "rbd",
334 .bus_attrs = rbd_bus_attrs,
335};
336
337static void rbd_root_dev_release(struct device *dev)
338{
339}
340
341static struct device rbd_root_dev = {
342 .init_name = "rbd",
343 .release = rbd_root_dev_release,
344};
345
Alex Elder06ecc6c2012-11-01 10:17:15 -0500346static __printf(2, 3)
347void rbd_warn(struct rbd_device *rbd_dev, const char *fmt, ...)
348{
349 struct va_format vaf;
350 va_list args;
351
352 va_start(args, fmt);
353 vaf.fmt = fmt;
354 vaf.va = &args;
355
356 if (!rbd_dev)
357 printk(KERN_WARNING "%s: %pV\n", RBD_DRV_NAME, &vaf);
358 else if (rbd_dev->disk)
359 printk(KERN_WARNING "%s: %s: %pV\n",
360 RBD_DRV_NAME, rbd_dev->disk->disk_name, &vaf);
361 else if (rbd_dev->spec && rbd_dev->spec->image_name)
362 printk(KERN_WARNING "%s: image %s: %pV\n",
363 RBD_DRV_NAME, rbd_dev->spec->image_name, &vaf);
364 else if (rbd_dev->spec && rbd_dev->spec->image_id)
365 printk(KERN_WARNING "%s: id %s: %pV\n",
366 RBD_DRV_NAME, rbd_dev->spec->image_id, &vaf);
367 else /* punt */
368 printk(KERN_WARNING "%s: rbd_dev %p: %pV\n",
369 RBD_DRV_NAME, rbd_dev, &vaf);
370 va_end(args);
371}
372
Alex Elderaafb2302012-09-06 16:00:54 -0500373#ifdef RBD_DEBUG
374#define rbd_assert(expr) \
375 if (unlikely(!(expr))) { \
376 printk(KERN_ERR "\nAssertion failure in %s() " \
377 "at line %d:\n\n" \
378 "\trbd_assert(%s);\n\n", \
379 __func__, __LINE__, #expr); \
380 BUG(); \
381 }
382#else /* !RBD_DEBUG */
383# define rbd_assert(expr) ((void) 0)
384#endif /* !RBD_DEBUG */
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800385
Alex Elder117973f2012-08-31 17:29:55 -0500386static int rbd_dev_refresh(struct rbd_device *rbd_dev, u64 *hver);
387static int rbd_dev_v2_refresh(struct rbd_device *rbd_dev, u64 *hver);
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700388
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700389static int rbd_open(struct block_device *bdev, fmode_t mode)
390{
Alex Elderf0f8cef2012-01-29 13:57:44 -0600391 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
Alex Elderb82d1672013-01-14 12:43:31 -0600392 bool removing = false;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700393
Alex Elderf84344f2012-08-31 17:29:51 -0500394 if ((mode & FMODE_WRITE) && rbd_dev->mapping.read_only)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700395 return -EROFS;
396
Alex Eldera14ea262013-02-05 13:23:12 -0600397 spin_lock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600398 if (test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags))
399 removing = true;
400 else
401 rbd_dev->open_count++;
Alex Eldera14ea262013-02-05 13:23:12 -0600402 spin_unlock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600403 if (removing)
404 return -ENOENT;
405
Alex Elder42382b72012-11-16 09:29:16 -0600406 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Alex Elderc3e946c2012-11-16 09:29:16 -0600407 (void) get_device(&rbd_dev->dev);
Alex Elderf84344f2012-08-31 17:29:51 -0500408 set_device_ro(bdev, rbd_dev->mapping.read_only);
Alex Elder42382b72012-11-16 09:29:16 -0600409 mutex_unlock(&ctl_mutex);
Alex Elder340c7a22012-08-10 13:12:07 -0700410
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700411 return 0;
412}
413
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800414static int rbd_release(struct gendisk *disk, fmode_t mode)
415{
416 struct rbd_device *rbd_dev = disk->private_data;
Alex Elderb82d1672013-01-14 12:43:31 -0600417 unsigned long open_count_before;
418
Alex Eldera14ea262013-02-05 13:23:12 -0600419 spin_lock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600420 open_count_before = rbd_dev->open_count--;
Alex Eldera14ea262013-02-05 13:23:12 -0600421 spin_unlock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -0600422 rbd_assert(open_count_before > 0);
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800423
Alex Elder42382b72012-11-16 09:29:16 -0600424 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Alex Elderc3e946c2012-11-16 09:29:16 -0600425 put_device(&rbd_dev->dev);
Alex Elder42382b72012-11-16 09:29:16 -0600426 mutex_unlock(&ctl_mutex);
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800427
428 return 0;
429}
430
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700431static const struct block_device_operations rbd_bd_ops = {
432 .owner = THIS_MODULE,
433 .open = rbd_open,
Yehuda Sadehdfc56062010-11-19 14:51:04 -0800434 .release = rbd_release,
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700435};
436
437/*
438 * Initialize an rbd client instance.
Alex Elder43ae4702012-07-03 16:01:18 -0500439 * We own *ceph_opts.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700440 */
Alex Elderf8c38922012-08-10 13:12:07 -0700441static struct rbd_client *rbd_client_create(struct ceph_options *ceph_opts)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700442{
443 struct rbd_client *rbdc;
444 int ret = -ENOMEM;
445
446 dout("rbd_client_create\n");
447 rbdc = kmalloc(sizeof(struct rbd_client), GFP_KERNEL);
448 if (!rbdc)
449 goto out_opt;
450
451 kref_init(&rbdc->kref);
452 INIT_LIST_HEAD(&rbdc->node);
453
Alex Elderbc534d862012-01-29 13:57:44 -0600454 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
455
Alex Elder43ae4702012-07-03 16:01:18 -0500456 rbdc->client = ceph_create_client(ceph_opts, rbdc, 0, 0);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700457 if (IS_ERR(rbdc->client))
Alex Elderbc534d862012-01-29 13:57:44 -0600458 goto out_mutex;
Alex Elder43ae4702012-07-03 16:01:18 -0500459 ceph_opts = NULL; /* Now rbdc->client is responsible for ceph_opts */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700460
461 ret = ceph_open_session(rbdc->client);
462 if (ret < 0)
463 goto out_err;
464
Alex Elder432b8582012-01-29 13:57:44 -0600465 spin_lock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700466 list_add_tail(&rbdc->node, &rbd_client_list);
Alex Elder432b8582012-01-29 13:57:44 -0600467 spin_unlock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700468
Alex Elderbc534d862012-01-29 13:57:44 -0600469 mutex_unlock(&ctl_mutex);
470
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700471 dout("rbd_client_create created %p\n", rbdc);
472 return rbdc;
473
474out_err:
475 ceph_destroy_client(rbdc->client);
Alex Elderbc534d862012-01-29 13:57:44 -0600476out_mutex:
477 mutex_unlock(&ctl_mutex);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700478 kfree(rbdc);
479out_opt:
Alex Elder43ae4702012-07-03 16:01:18 -0500480 if (ceph_opts)
481 ceph_destroy_options(ceph_opts);
Vasiliy Kulikov28f259b2010-09-26 12:59:37 +0400482 return ERR_PTR(ret);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700483}
484
485/*
Alex Elder1f7ba332012-08-10 13:12:07 -0700486 * Find a ceph client with specific addr and configuration. If
487 * found, bump its reference count.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700488 */
Alex Elder1f7ba332012-08-10 13:12:07 -0700489static struct rbd_client *rbd_client_find(struct ceph_options *ceph_opts)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700490{
491 struct rbd_client *client_node;
Alex Elder1f7ba332012-08-10 13:12:07 -0700492 bool found = false;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700493
Alex Elder43ae4702012-07-03 16:01:18 -0500494 if (ceph_opts->flags & CEPH_OPT_NOSHARE)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700495 return NULL;
496
Alex Elder1f7ba332012-08-10 13:12:07 -0700497 spin_lock(&rbd_client_list_lock);
498 list_for_each_entry(client_node, &rbd_client_list, node) {
499 if (!ceph_compare_options(ceph_opts, client_node->client)) {
500 kref_get(&client_node->kref);
501 found = true;
502 break;
503 }
504 }
505 spin_unlock(&rbd_client_list_lock);
506
507 return found ? client_node : NULL;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700508}
509
510/*
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700511 * mount options
512 */
513enum {
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700514 Opt_last_int,
515 /* int args above */
516 Opt_last_string,
517 /* string args above */
Alex Eldercc0538b2012-08-10 13:12:07 -0700518 Opt_read_only,
519 Opt_read_write,
520 /* Boolean args above */
521 Opt_last_bool,
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700522};
523
Alex Elder43ae4702012-07-03 16:01:18 -0500524static match_table_t rbd_opts_tokens = {
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700525 /* int args above */
526 /* string args above */
Alex Elderbe466c12012-10-22 11:31:26 -0500527 {Opt_read_only, "read_only"},
Alex Eldercc0538b2012-08-10 13:12:07 -0700528 {Opt_read_only, "ro"}, /* Alternate spelling */
529 {Opt_read_write, "read_write"},
530 {Opt_read_write, "rw"}, /* Alternate spelling */
531 /* Boolean args above */
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700532 {-1, NULL}
533};
534
Alex Elder98571b52013-01-20 14:44:42 -0600535struct rbd_options {
536 bool read_only;
537};
538
539#define RBD_READ_ONLY_DEFAULT false
540
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700541static int parse_rbd_opts_token(char *c, void *private)
542{
Alex Elder43ae4702012-07-03 16:01:18 -0500543 struct rbd_options *rbd_opts = private;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700544 substring_t argstr[MAX_OPT_ARGS];
545 int token, intval, ret;
546
Alex Elder43ae4702012-07-03 16:01:18 -0500547 token = match_token(c, rbd_opts_tokens, argstr);
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700548 if (token < 0)
549 return -EINVAL;
550
551 if (token < Opt_last_int) {
552 ret = match_int(&argstr[0], &intval);
553 if (ret < 0) {
554 pr_err("bad mount option arg (not int) "
555 "at '%s'\n", c);
556 return ret;
557 }
558 dout("got int token %d val %d\n", token, intval);
559 } else if (token > Opt_last_int && token < Opt_last_string) {
560 dout("got string token %d val %s\n", token,
561 argstr[0].from);
Alex Eldercc0538b2012-08-10 13:12:07 -0700562 } else if (token > Opt_last_string && token < Opt_last_bool) {
563 dout("got Boolean token %d\n", token);
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700564 } else {
565 dout("got token %d\n", token);
566 }
567
568 switch (token) {
Alex Eldercc0538b2012-08-10 13:12:07 -0700569 case Opt_read_only:
570 rbd_opts->read_only = true;
571 break;
572 case Opt_read_write:
573 rbd_opts->read_only = false;
574 break;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700575 default:
Alex Elderaafb2302012-09-06 16:00:54 -0500576 rbd_assert(false);
577 break;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700578 }
579 return 0;
580}
581
582/*
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700583 * Get a ceph client with specific addr and configuration, if one does
584 * not exist create it.
585 */
Alex Elder9d3997f2012-10-25 23:34:42 -0500586static struct rbd_client *rbd_get_client(struct ceph_options *ceph_opts)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700587{
Alex Elderf8c38922012-08-10 13:12:07 -0700588 struct rbd_client *rbdc;
Yehuda Sadeh59c2be12011-03-21 15:10:11 -0700589
Alex Elder1f7ba332012-08-10 13:12:07 -0700590 rbdc = rbd_client_find(ceph_opts);
Alex Elder9d3997f2012-10-25 23:34:42 -0500591 if (rbdc) /* using an existing client */
Alex Elder43ae4702012-07-03 16:01:18 -0500592 ceph_destroy_options(ceph_opts);
Alex Elder9d3997f2012-10-25 23:34:42 -0500593 else
Alex Elderf8c38922012-08-10 13:12:07 -0700594 rbdc = rbd_client_create(ceph_opts);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700595
Alex Elder9d3997f2012-10-25 23:34:42 -0500596 return rbdc;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700597}
598
599/*
600 * Destroy ceph client
Alex Elderd23a4b32012-01-29 13:57:43 -0600601 *
Alex Elder432b8582012-01-29 13:57:44 -0600602 * Caller must hold rbd_client_list_lock.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700603 */
604static void rbd_client_release(struct kref *kref)
605{
606 struct rbd_client *rbdc = container_of(kref, struct rbd_client, kref);
607
608 dout("rbd_release_client %p\n", rbdc);
Alex Eldercd9d9f52012-04-04 13:35:44 -0500609 spin_lock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700610 list_del(&rbdc->node);
Alex Eldercd9d9f52012-04-04 13:35:44 -0500611 spin_unlock(&rbd_client_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700612
613 ceph_destroy_client(rbdc->client);
614 kfree(rbdc);
615}
616
617/*
618 * Drop reference to ceph client node. If it's not referenced anymore, release
619 * it.
620 */
Alex Elder9d3997f2012-10-25 23:34:42 -0500621static void rbd_put_client(struct rbd_client *rbdc)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700622{
Alex Elderc53d5892012-10-25 23:34:42 -0500623 if (rbdc)
624 kref_put(&rbdc->kref, rbd_client_release);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700625}
626
Alex Eldera30b71b2012-07-10 20:30:11 -0500627static bool rbd_image_format_valid(u32 image_format)
628{
629 return image_format == 1 || image_format == 2;
630}
631
Alex Elder8e94af82012-07-25 09:32:40 -0500632static bool rbd_dev_ondisk_valid(struct rbd_image_header_ondisk *ondisk)
633{
Alex Elder103a1502012-08-02 11:29:45 -0500634 size_t size;
635 u32 snap_count;
636
637 /* The header has to start with the magic rbd header text */
638 if (memcmp(&ondisk->text, RBD_HEADER_TEXT, sizeof (RBD_HEADER_TEXT)))
639 return false;
640
Alex Elderdb2388b2012-10-20 22:17:27 -0500641 /* The bio layer requires at least sector-sized I/O */
642
643 if (ondisk->options.order < SECTOR_SHIFT)
644 return false;
645
646 /* If we use u64 in a few spots we may be able to loosen this */
647
648 if (ondisk->options.order > 8 * sizeof (int) - 1)
649 return false;
650
Alex Elder103a1502012-08-02 11:29:45 -0500651 /*
652 * The size of a snapshot header has to fit in a size_t, and
653 * that limits the number of snapshots.
654 */
655 snap_count = le32_to_cpu(ondisk->snap_count);
656 size = SIZE_MAX - sizeof (struct ceph_snap_context);
657 if (snap_count > size / sizeof (__le64))
658 return false;
659
660 /*
661 * Not only that, but the size of the entire the snapshot
662 * header must also be representable in a size_t.
663 */
664 size -= snap_count * sizeof (__le64);
665 if ((u64) size < le64_to_cpu(ondisk->snap_names_len))
666 return false;
667
668 return true;
Alex Elder8e94af82012-07-25 09:32:40 -0500669}
670
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700671/*
672 * Create a new header structure, translate header format from the on-disk
673 * header.
674 */
675static int rbd_header_from_disk(struct rbd_image_header *header,
Alex Elder4156d992012-08-02 11:29:46 -0500676 struct rbd_image_header_ondisk *ondisk)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700677{
Alex Elderccece232012-07-10 20:30:10 -0500678 u32 snap_count;
Alex Elder58c17b02012-08-23 23:22:06 -0500679 size_t len;
Alex Elderd2bb24e2012-07-26 23:37:14 -0500680 size_t size;
Alex Elder621901d2012-08-23 23:22:06 -0500681 u32 i;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700682
Alex Elder6a523252012-07-19 17:12:59 -0500683 memset(header, 0, sizeof (*header));
684
Alex Elder103a1502012-08-02 11:29:45 -0500685 snap_count = le32_to_cpu(ondisk->snap_count);
686
Alex Elder58c17b02012-08-23 23:22:06 -0500687 len = strnlen(ondisk->object_prefix, sizeof (ondisk->object_prefix));
688 header->object_prefix = kmalloc(len + 1, GFP_KERNEL);
Alex Elder6a523252012-07-19 17:12:59 -0500689 if (!header->object_prefix)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700690 return -ENOMEM;
Alex Elder58c17b02012-08-23 23:22:06 -0500691 memcpy(header->object_prefix, ondisk->object_prefix, len);
692 header->object_prefix[len] = '\0';
Alex Elder00f1f362012-02-07 12:03:36 -0600693
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700694 if (snap_count) {
Alex Elderf785cc12012-08-23 23:22:06 -0500695 u64 snap_names_len = le64_to_cpu(ondisk->snap_names_len);
696
Alex Elder621901d2012-08-23 23:22:06 -0500697 /* Save a copy of the snapshot names */
698
Alex Elderf785cc12012-08-23 23:22:06 -0500699 if (snap_names_len > (u64) SIZE_MAX)
700 return -EIO;
701 header->snap_names = kmalloc(snap_names_len, GFP_KERNEL);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700702 if (!header->snap_names)
Alex Elder6a523252012-07-19 17:12:59 -0500703 goto out_err;
Alex Elderf785cc12012-08-23 23:22:06 -0500704 /*
705 * Note that rbd_dev_v1_header_read() guarantees
706 * the ondisk buffer we're working with has
707 * snap_names_len bytes beyond the end of the
708 * snapshot id array, this memcpy() is safe.
709 */
710 memcpy(header->snap_names, &ondisk->snaps[snap_count],
711 snap_names_len);
Alex Elder6a523252012-07-19 17:12:59 -0500712
Alex Elder621901d2012-08-23 23:22:06 -0500713 /* Record each snapshot's size */
714
Alex Elderd2bb24e2012-07-26 23:37:14 -0500715 size = snap_count * sizeof (*header->snap_sizes);
716 header->snap_sizes = kmalloc(size, GFP_KERNEL);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700717 if (!header->snap_sizes)
Alex Elder6a523252012-07-19 17:12:59 -0500718 goto out_err;
Alex Elder621901d2012-08-23 23:22:06 -0500719 for (i = 0; i < snap_count; i++)
720 header->snap_sizes[i] =
721 le64_to_cpu(ondisk->snaps[i].image_size);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700722 } else {
Alex Elderccece232012-07-10 20:30:10 -0500723 WARN_ON(ondisk->snap_names_len);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700724 header->snap_names = NULL;
725 header->snap_sizes = NULL;
726 }
Alex Elder849b4262012-07-09 21:04:24 -0500727
Alex Elder34b13182012-07-13 20:35:12 -0500728 header->features = 0; /* No features support in v1 images */
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700729 header->obj_order = ondisk->options.order;
730 header->crypt_type = ondisk->options.crypt_type;
731 header->comp_type = ondisk->options.comp_type;
Alex Elder6a523252012-07-19 17:12:59 -0500732
Alex Elder621901d2012-08-23 23:22:06 -0500733 /* Allocate and fill in the snapshot context */
734
Alex Elderf84344f2012-08-31 17:29:51 -0500735 header->image_size = le64_to_cpu(ondisk->image_size);
Alex Elder6a523252012-07-19 17:12:59 -0500736 size = sizeof (struct ceph_snap_context);
737 size += snap_count * sizeof (header->snapc->snaps[0]);
738 header->snapc = kzalloc(size, GFP_KERNEL);
739 if (!header->snapc)
740 goto out_err;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700741
742 atomic_set(&header->snapc->nref, 1);
Alex Elder505cbb92012-07-19 08:49:18 -0500743 header->snapc->seq = le64_to_cpu(ondisk->snap_seq);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700744 header->snapc->num_snaps = snap_count;
Alex Elder621901d2012-08-23 23:22:06 -0500745 for (i = 0; i < snap_count; i++)
746 header->snapc->snaps[i] =
747 le64_to_cpu(ondisk->snaps[i].id);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700748
749 return 0;
750
Alex Elder6a523252012-07-19 17:12:59 -0500751out_err:
Alex Elder849b4262012-07-09 21:04:24 -0500752 kfree(header->snap_sizes);
Alex Elderccece232012-07-10 20:30:10 -0500753 header->snap_sizes = NULL;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700754 kfree(header->snap_names);
Alex Elderccece232012-07-10 20:30:10 -0500755 header->snap_names = NULL;
Alex Elder6a523252012-07-19 17:12:59 -0500756 kfree(header->object_prefix);
757 header->object_prefix = NULL;
Alex Elderccece232012-07-10 20:30:10 -0500758
Alex Elder00f1f362012-02-07 12:03:36 -0600759 return -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700760}
761
Alex Elder9e15b772012-10-30 19:40:33 -0500762static const char *rbd_snap_name(struct rbd_device *rbd_dev, u64 snap_id)
763{
764 struct rbd_snap *snap;
765
766 if (snap_id == CEPH_NOSNAP)
767 return RBD_SNAP_HEAD_NAME;
768
769 list_for_each_entry(snap, &rbd_dev->snaps, node)
770 if (snap_id == snap->id)
771 return snap->name;
772
773 return NULL;
774}
775
Alex Elder8836b992012-08-30 14:42:15 -0500776static int snap_by_name(struct rbd_device *rbd_dev, const char *snap_name)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700777{
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700778
Alex Eldere86924a2012-07-10 20:30:11 -0500779 struct rbd_snap *snap;
Alex Elder00f1f362012-02-07 12:03:36 -0600780
Alex Eldere86924a2012-07-10 20:30:11 -0500781 list_for_each_entry(snap, &rbd_dev->snaps, node) {
782 if (!strcmp(snap_name, snap->name)) {
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500783 rbd_dev->spec->snap_id = snap->id;
Alex Eldere86924a2012-07-10 20:30:11 -0500784 rbd_dev->mapping.size = snap->size;
Alex Elder34b13182012-07-13 20:35:12 -0500785 rbd_dev->mapping.features = snap->features;
Alex Elder00f1f362012-02-07 12:03:36 -0600786
Alex Eldere86924a2012-07-10 20:30:11 -0500787 return 0;
Alex Elder00f1f362012-02-07 12:03:36 -0600788 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700789 }
Alex Eldere86924a2012-07-10 20:30:11 -0500790
Alex Elder00f1f362012-02-07 12:03:36 -0600791 return -ENOENT;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700792}
793
Alex Elder819d52b2012-10-25 23:34:41 -0500794static int rbd_dev_set_mapping(struct rbd_device *rbd_dev)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700795{
Alex Elder78dc4472012-07-19 08:49:18 -0500796 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700797
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500798 if (!memcmp(rbd_dev->spec->snap_name, RBD_SNAP_HEAD_NAME,
Josh Durgincc9d7342011-11-21 18:19:13 -0800799 sizeof (RBD_SNAP_HEAD_NAME))) {
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500800 rbd_dev->spec->snap_id = CEPH_NOSNAP;
Alex Elder99c1f082012-08-30 14:42:15 -0500801 rbd_dev->mapping.size = rbd_dev->header.image_size;
Alex Elder34b13182012-07-13 20:35:12 -0500802 rbd_dev->mapping.features = rbd_dev->header.features;
Alex Eldere86924a2012-07-10 20:30:11 -0500803 ret = 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700804 } else {
Alex Elder0d7dbfc2012-10-25 23:34:41 -0500805 ret = snap_by_name(rbd_dev, rbd_dev->spec->snap_name);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700806 if (ret < 0)
807 goto done;
Alex Elderf84344f2012-08-31 17:29:51 -0500808 rbd_dev->mapping.read_only = true;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700809 }
Alex Elder6d292902013-01-14 12:43:31 -0600810 set_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
811
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700812done:
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700813 return ret;
814}
815
816static void rbd_header_free(struct rbd_image_header *header)
817{
Alex Elder849b4262012-07-09 21:04:24 -0500818 kfree(header->object_prefix);
Alex Elderd78fd7a2012-07-26 23:37:14 -0500819 header->object_prefix = NULL;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700820 kfree(header->snap_sizes);
Alex Elderd78fd7a2012-07-26 23:37:14 -0500821 header->snap_sizes = NULL;
Alex Elder849b4262012-07-09 21:04:24 -0500822 kfree(header->snap_names);
Alex Elderd78fd7a2012-07-26 23:37:14 -0500823 header->snap_names = NULL;
Josh Durgind1d25642011-12-05 14:03:05 -0800824 ceph_put_snap_context(header->snapc);
Alex Elderd78fd7a2012-07-26 23:37:14 -0500825 header->snapc = NULL;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700826}
827
Alex Elder98571b52013-01-20 14:44:42 -0600828static const char *rbd_segment_name(struct rbd_device *rbd_dev, u64 offset)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700829{
Alex Elder65ccfe22012-08-09 10:33:26 -0700830 char *name;
831 u64 segment;
832 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700833
Alex Elder2fd82b92012-11-09 15:05:54 -0600834 name = kmalloc(MAX_OBJ_NAME_SIZE + 1, GFP_NOIO);
Alex Elder65ccfe22012-08-09 10:33:26 -0700835 if (!name)
836 return NULL;
837 segment = offset >> rbd_dev->header.obj_order;
Alex Elder2fd82b92012-11-09 15:05:54 -0600838 ret = snprintf(name, MAX_OBJ_NAME_SIZE + 1, "%s.%012llx",
Alex Elder65ccfe22012-08-09 10:33:26 -0700839 rbd_dev->header.object_prefix, segment);
Alex Elder2fd82b92012-11-09 15:05:54 -0600840 if (ret < 0 || ret > MAX_OBJ_NAME_SIZE) {
Alex Elder65ccfe22012-08-09 10:33:26 -0700841 pr_err("error formatting segment name for #%llu (%d)\n",
842 segment, ret);
843 kfree(name);
844 name = NULL;
845 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700846
Alex Elder65ccfe22012-08-09 10:33:26 -0700847 return name;
848}
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700849
Alex Elder65ccfe22012-08-09 10:33:26 -0700850static u64 rbd_segment_offset(struct rbd_device *rbd_dev, u64 offset)
851{
852 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700853
Alex Elder65ccfe22012-08-09 10:33:26 -0700854 return offset & (segment_size - 1);
855}
856
857static u64 rbd_segment_length(struct rbd_device *rbd_dev,
858 u64 offset, u64 length)
859{
860 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
861
862 offset &= segment_size - 1;
863
Alex Elderaafb2302012-09-06 16:00:54 -0500864 rbd_assert(length <= U64_MAX - offset);
Alex Elder65ccfe22012-08-09 10:33:26 -0700865 if (offset + length > segment_size)
866 length = segment_size - offset;
867
868 return length;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700869}
870
871/*
Josh Durgin029bcbd2011-07-22 11:35:23 -0700872 * returns the size of an object in the image
873 */
874static u64 rbd_obj_bytes(struct rbd_image_header *header)
875{
876 return 1 << header->obj_order;
877}
878
879/*
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700880 * bio helpers
881 */
882
883static void bio_chain_put(struct bio *chain)
884{
885 struct bio *tmp;
886
887 while (chain) {
888 tmp = chain;
889 chain = chain->bi_next;
890 bio_put(tmp);
891 }
892}
893
894/*
895 * zeros a bio chain, starting at specific offset
896 */
897static void zero_bio_chain(struct bio *chain, int start_ofs)
898{
899 struct bio_vec *bv;
900 unsigned long flags;
901 void *buf;
902 int i;
903 int pos = 0;
904
905 while (chain) {
906 bio_for_each_segment(bv, chain, i) {
907 if (pos + bv->bv_len > start_ofs) {
908 int remainder = max(start_ofs - pos, 0);
909 buf = bvec_kmap_irq(bv, &flags);
910 memset(buf + remainder, 0,
911 bv->bv_len - remainder);
Dan Carpenter85b5aaa2010-10-11 21:15:11 +0200912 bvec_kunmap_irq(buf, &flags);
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700913 }
914 pos += bv->bv_len;
915 }
916
917 chain = chain->bi_next;
918 }
919}
920
921/*
Alex Elderf7760da2012-10-20 22:17:27 -0500922 * Clone a portion of a bio, starting at the given byte offset
923 * and continuing for the number of bytes indicated.
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700924 */
Alex Elderf7760da2012-10-20 22:17:27 -0500925static struct bio *bio_clone_range(struct bio *bio_src,
926 unsigned int offset,
927 unsigned int len,
928 gfp_t gfpmask)
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700929{
Alex Elderf7760da2012-10-20 22:17:27 -0500930 struct bio_vec *bv;
931 unsigned int resid;
932 unsigned short idx;
933 unsigned int voff;
934 unsigned short end_idx;
935 unsigned short vcnt;
936 struct bio *bio;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700937
Alex Elderf7760da2012-10-20 22:17:27 -0500938 /* Handle the easy case for the caller */
939
940 if (!offset && len == bio_src->bi_size)
941 return bio_clone(bio_src, gfpmask);
942
943 if (WARN_ON_ONCE(!len))
944 return NULL;
945 if (WARN_ON_ONCE(len > bio_src->bi_size))
946 return NULL;
947 if (WARN_ON_ONCE(offset > bio_src->bi_size - len))
948 return NULL;
949
950 /* Find first affected segment... */
951
952 resid = offset;
953 __bio_for_each_segment(bv, bio_src, idx, 0) {
954 if (resid < bv->bv_len)
955 break;
956 resid -= bv->bv_len;
957 }
958 voff = resid;
959
960 /* ...and the last affected segment */
961
962 resid += len;
963 __bio_for_each_segment(bv, bio_src, end_idx, idx) {
964 if (resid <= bv->bv_len)
965 break;
966 resid -= bv->bv_len;
967 }
968 vcnt = end_idx - idx + 1;
969
970 /* Build the clone */
971
972 bio = bio_alloc(gfpmask, (unsigned int) vcnt);
973 if (!bio)
974 return NULL; /* ENOMEM */
975
976 bio->bi_bdev = bio_src->bi_bdev;
977 bio->bi_sector = bio_src->bi_sector + (offset >> SECTOR_SHIFT);
978 bio->bi_rw = bio_src->bi_rw;
979 bio->bi_flags |= 1 << BIO_CLONED;
980
981 /*
982 * Copy over our part of the bio_vec, then update the first
983 * and last (or only) entries.
984 */
985 memcpy(&bio->bi_io_vec[0], &bio_src->bi_io_vec[idx],
986 vcnt * sizeof (struct bio_vec));
987 bio->bi_io_vec[0].bv_offset += voff;
988 if (vcnt > 1) {
989 bio->bi_io_vec[0].bv_len -= voff;
990 bio->bi_io_vec[vcnt - 1].bv_len = resid;
991 } else {
992 bio->bi_io_vec[0].bv_len = len;
Yehuda Sadeh602adf42010-08-12 16:11:25 -0700993 }
994
Alex Elderf7760da2012-10-20 22:17:27 -0500995 bio->bi_vcnt = vcnt;
996 bio->bi_size = len;
997 bio->bi_idx = 0;
Alex Elder542582f2012-08-09 10:33:25 -0700998
Alex Elderf7760da2012-10-20 22:17:27 -0500999 return bio;
1000}
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001001
Alex Elderf7760da2012-10-20 22:17:27 -05001002/*
1003 * Clone a portion of a bio chain, starting at the given byte offset
1004 * into the first bio in the source chain and continuing for the
1005 * number of bytes indicated. The result is another bio chain of
1006 * exactly the given length, or a null pointer on error.
1007 *
1008 * The bio_src and offset parameters are both in-out. On entry they
1009 * refer to the first source bio and the offset into that bio where
1010 * the start of data to be cloned is located.
1011 *
1012 * On return, bio_src is updated to refer to the bio in the source
1013 * chain that contains first un-cloned byte, and *offset will
1014 * contain the offset of that byte within that bio.
1015 */
1016static struct bio *bio_chain_clone_range(struct bio **bio_src,
1017 unsigned int *offset,
1018 unsigned int len,
1019 gfp_t gfpmask)
1020{
1021 struct bio *bi = *bio_src;
1022 unsigned int off = *offset;
1023 struct bio *chain = NULL;
1024 struct bio **end;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001025
Alex Elderf7760da2012-10-20 22:17:27 -05001026 /* Build up a chain of clone bios up to the limit */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001027
Alex Elderf7760da2012-10-20 22:17:27 -05001028 if (!bi || off >= bi->bi_size || !len)
1029 return NULL; /* Nothing to clone */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001030
Alex Elderf7760da2012-10-20 22:17:27 -05001031 end = &chain;
1032 while (len) {
1033 unsigned int bi_size;
1034 struct bio *bio;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001035
Alex Elderf5400b72012-11-01 10:17:15 -05001036 if (!bi) {
1037 rbd_warn(NULL, "bio_chain exhausted with %u left", len);
Alex Elderf7760da2012-10-20 22:17:27 -05001038 goto out_err; /* EINVAL; ran out of bio's */
Alex Elderf5400b72012-11-01 10:17:15 -05001039 }
Alex Elderf7760da2012-10-20 22:17:27 -05001040 bi_size = min_t(unsigned int, bi->bi_size - off, len);
1041 bio = bio_clone_range(bi, off, bi_size, gfpmask);
1042 if (!bio)
1043 goto out_err; /* ENOMEM */
1044
1045 *end = bio;
1046 end = &bio->bi_next;
1047
1048 off += bi_size;
1049 if (off == bi->bi_size) {
1050 bi = bi->bi_next;
1051 off = 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001052 }
Alex Elderf7760da2012-10-20 22:17:27 -05001053 len -= bi_size;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001054 }
Alex Elderf7760da2012-10-20 22:17:27 -05001055 *bio_src = bi;
1056 *offset = off;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001057
Alex Elderf7760da2012-10-20 22:17:27 -05001058 return chain;
1059out_err:
1060 bio_chain_put(chain);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001061
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001062 return NULL;
1063}
1064
Alex Elderbf0d5f502012-11-22 00:00:08 -06001065static void rbd_obj_request_get(struct rbd_obj_request *obj_request)
1066{
1067 kref_get(&obj_request->kref);
1068}
1069
1070static void rbd_obj_request_destroy(struct kref *kref);
1071static void rbd_obj_request_put(struct rbd_obj_request *obj_request)
1072{
1073 rbd_assert(obj_request != NULL);
1074 kref_put(&obj_request->kref, rbd_obj_request_destroy);
1075}
1076
1077static void rbd_img_request_get(struct rbd_img_request *img_request)
1078{
1079 kref_get(&img_request->kref);
1080}
1081
1082static void rbd_img_request_destroy(struct kref *kref);
1083static void rbd_img_request_put(struct rbd_img_request *img_request)
1084{
1085 rbd_assert(img_request != NULL);
1086 kref_put(&img_request->kref, rbd_img_request_destroy);
1087}
1088
1089static inline void rbd_img_obj_request_add(struct rbd_img_request *img_request,
1090 struct rbd_obj_request *obj_request)
1091{
Alex Elder25dcf952013-01-25 17:08:55 -06001092 rbd_assert(obj_request->img_request == NULL);
1093
Alex Elderbf0d5f502012-11-22 00:00:08 -06001094 rbd_obj_request_get(obj_request);
1095 obj_request->img_request = img_request;
Alex Elder25dcf952013-01-25 17:08:55 -06001096 obj_request->which = img_request->obj_request_count;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001097 rbd_assert(obj_request->which != BAD_WHICH);
Alex Elder25dcf952013-01-25 17:08:55 -06001098 img_request->obj_request_count++;
1099 list_add_tail(&obj_request->links, &img_request->obj_requests);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001100}
1101
1102static inline void rbd_img_obj_request_del(struct rbd_img_request *img_request,
1103 struct rbd_obj_request *obj_request)
1104{
1105 rbd_assert(obj_request->which != BAD_WHICH);
Alex Elder25dcf952013-01-25 17:08:55 -06001106
Alex Elderbf0d5f502012-11-22 00:00:08 -06001107 list_del(&obj_request->links);
Alex Elder25dcf952013-01-25 17:08:55 -06001108 rbd_assert(img_request->obj_request_count > 0);
1109 img_request->obj_request_count--;
1110 rbd_assert(obj_request->which == img_request->obj_request_count);
1111 obj_request->which = BAD_WHICH;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001112 rbd_assert(obj_request->img_request == img_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001113 obj_request->img_request = NULL;
Alex Elder25dcf952013-01-25 17:08:55 -06001114 obj_request->callback = NULL;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001115 rbd_obj_request_put(obj_request);
1116}
1117
1118static bool obj_request_type_valid(enum obj_request_type type)
1119{
1120 switch (type) {
Alex Elder9969ebc2013-01-18 12:31:10 -06001121 case OBJ_REQUEST_NODATA:
Alex Elderbf0d5f502012-11-22 00:00:08 -06001122 case OBJ_REQUEST_BIO:
Alex Elder788e2df2013-01-17 12:25:27 -06001123 case OBJ_REQUEST_PAGES:
Alex Elderbf0d5f502012-11-22 00:00:08 -06001124 return true;
1125 default:
1126 return false;
1127 }
1128}
1129
Alex Elder8d23bf22012-11-19 22:55:21 -06001130struct ceph_osd_req_op *rbd_osd_req_op_create(u16 opcode, ...)
1131{
1132 struct ceph_osd_req_op *op;
1133 va_list args;
Alex Elder2647ba32012-11-19 22:55:21 -06001134 size_t size;
Alex Elder8d23bf22012-11-19 22:55:21 -06001135
1136 op = kzalloc(sizeof (*op), GFP_NOIO);
1137 if (!op)
1138 return NULL;
1139 op->op = opcode;
1140 va_start(args, opcode);
1141 switch (opcode) {
1142 case CEPH_OSD_OP_READ:
1143 case CEPH_OSD_OP_WRITE:
1144 /* rbd_osd_req_op_create(READ, offset, length) */
1145 /* rbd_osd_req_op_create(WRITE, offset, length) */
1146 op->extent.offset = va_arg(args, u64);
1147 op->extent.length = va_arg(args, u64);
1148 if (opcode == CEPH_OSD_OP_WRITE)
1149 op->payload_len = op->extent.length;
1150 break;
Alex Elderfbfab532013-02-08 09:55:48 -06001151 case CEPH_OSD_OP_STAT:
1152 break;
Alex Elder2647ba32012-11-19 22:55:21 -06001153 case CEPH_OSD_OP_CALL:
1154 /* rbd_osd_req_op_create(CALL, class, method, data, datalen) */
1155 op->cls.class_name = va_arg(args, char *);
1156 size = strlen(op->cls.class_name);
1157 rbd_assert(size <= (size_t) U8_MAX);
1158 op->cls.class_len = size;
1159 op->payload_len = size;
1160
1161 op->cls.method_name = va_arg(args, char *);
1162 size = strlen(op->cls.method_name);
1163 rbd_assert(size <= (size_t) U8_MAX);
1164 op->cls.method_len = size;
1165 op->payload_len += size;
1166
1167 op->cls.argc = 0;
1168 op->cls.indata = va_arg(args, void *);
1169 size = va_arg(args, size_t);
1170 rbd_assert(size <= (size_t) U32_MAX);
1171 op->cls.indata_len = (u32) size;
1172 op->payload_len += size;
1173 break;
Alex Elder5efea492012-11-19 22:55:21 -06001174 case CEPH_OSD_OP_NOTIFY_ACK:
1175 case CEPH_OSD_OP_WATCH:
1176 /* rbd_osd_req_op_create(NOTIFY_ACK, cookie, version) */
1177 /* rbd_osd_req_op_create(WATCH, cookie, version, flag) */
1178 op->watch.cookie = va_arg(args, u64);
1179 op->watch.ver = va_arg(args, u64);
1180 op->watch.ver = cpu_to_le64(op->watch.ver);
1181 if (opcode == CEPH_OSD_OP_WATCH && va_arg(args, int))
1182 op->watch.flag = (u8) 1;
1183 break;
Alex Elder8d23bf22012-11-19 22:55:21 -06001184 default:
1185 rbd_warn(NULL, "unsupported opcode %hu\n", opcode);
1186 kfree(op);
1187 op = NULL;
1188 break;
1189 }
1190 va_end(args);
1191
1192 return op;
1193}
1194
1195static void rbd_osd_req_op_destroy(struct ceph_osd_req_op *op)
1196{
1197 kfree(op);
1198}
1199
Alex Elderbf0d5f502012-11-22 00:00:08 -06001200static int rbd_obj_request_submit(struct ceph_osd_client *osdc,
1201 struct rbd_obj_request *obj_request)
1202{
1203 return ceph_osdc_start_request(osdc, obj_request->osd_req, false);
1204}
1205
1206static void rbd_img_request_complete(struct rbd_img_request *img_request)
1207{
1208 if (img_request->callback)
1209 img_request->callback(img_request);
1210 else
1211 rbd_img_request_put(img_request);
1212}
1213
Alex Elder788e2df2013-01-17 12:25:27 -06001214/* Caller is responsible for rbd_obj_request_destroy(obj_request) */
1215
1216static int rbd_obj_request_wait(struct rbd_obj_request *obj_request)
1217{
1218 return wait_for_completion_interruptible(&obj_request->completion);
1219}
1220
Alex Elder07741302013-02-05 23:41:50 -06001221static void obj_request_done_init(struct rbd_obj_request *obj_request)
1222{
1223 atomic_set(&obj_request->done, 0);
1224 smp_wmb();
1225}
1226
1227static void obj_request_done_set(struct rbd_obj_request *obj_request)
1228{
1229 atomic_set(&obj_request->done, 1);
1230 smp_wmb();
1231}
1232
1233static bool obj_request_done_test(struct rbd_obj_request *obj_request)
1234{
1235 smp_rmb();
1236 return atomic_read(&obj_request->done) != 0;
1237}
1238
Alex Elder9969ebc2013-01-18 12:31:10 -06001239static void rbd_osd_trivial_callback(struct rbd_obj_request *obj_request,
1240 struct ceph_osd_op *op)
1241{
Alex Elder07741302013-02-05 23:41:50 -06001242 obj_request_done_set(obj_request);
Alex Elder9969ebc2013-01-18 12:31:10 -06001243}
1244
Alex Elderbf0d5f502012-11-22 00:00:08 -06001245static void rbd_obj_request_complete(struct rbd_obj_request *obj_request)
1246{
1247 if (obj_request->callback)
1248 obj_request->callback(obj_request);
Alex Elder788e2df2013-01-17 12:25:27 -06001249 else
1250 complete_all(&obj_request->completion);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001251}
1252
Alex Elderbf0d5f502012-11-22 00:00:08 -06001253static void rbd_osd_read_callback(struct rbd_obj_request *obj_request,
1254 struct ceph_osd_op *op)
1255{
1256 u64 xferred;
1257
1258 /*
1259 * We support a 64-bit length, but ultimately it has to be
1260 * passed to blk_end_request(), which takes an unsigned int.
1261 */
1262 xferred = le64_to_cpu(op->extent.length);
1263 rbd_assert(xferred < (u64) UINT_MAX);
1264 if (obj_request->result == (s32) -ENOENT) {
1265 zero_bio_chain(obj_request->bio_list, 0);
1266 obj_request->result = 0;
1267 } else if (xferred < obj_request->length && !obj_request->result) {
1268 zero_bio_chain(obj_request->bio_list, xferred);
1269 xferred = obj_request->length;
1270 }
1271 obj_request->xferred = xferred;
Alex Elder07741302013-02-05 23:41:50 -06001272 obj_request_done_set(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001273}
1274
1275static void rbd_osd_write_callback(struct rbd_obj_request *obj_request,
1276 struct ceph_osd_op *op)
1277{
1278 obj_request->xferred = le64_to_cpu(op->extent.length);
Alex Elder07741302013-02-05 23:41:50 -06001279 obj_request_done_set(obj_request);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001280}
1281
Alex Elderfbfab532013-02-08 09:55:48 -06001282/*
1283 * For a simple stat call there's nothing to do. We'll do more if
1284 * this is part of a write sequence for a layered image.
1285 */
1286static void rbd_osd_stat_callback(struct rbd_obj_request *obj_request,
1287 struct ceph_osd_op *op)
1288{
1289 obj_request_done_set(obj_request);
1290}
1291
Alex Elderbf0d5f502012-11-22 00:00:08 -06001292static void rbd_osd_req_callback(struct ceph_osd_request *osd_req,
1293 struct ceph_msg *msg)
1294{
1295 struct rbd_obj_request *obj_request = osd_req->r_priv;
1296 struct ceph_osd_reply_head *reply_head;
1297 struct ceph_osd_op *op;
1298 u32 num_ops;
1299 u16 opcode;
1300
1301 rbd_assert(osd_req == obj_request->osd_req);
1302 rbd_assert(!!obj_request->img_request ^
1303 (obj_request->which == BAD_WHICH));
1304
1305 obj_request->xferred = le32_to_cpu(msg->hdr.data_len);
1306 reply_head = msg->front.iov_base;
1307 obj_request->result = (s32) le32_to_cpu(reply_head->result);
1308 obj_request->version = le64_to_cpu(osd_req->r_reassert_version.version);
1309
1310 num_ops = le32_to_cpu(reply_head->num_ops);
1311 WARN_ON(num_ops != 1); /* For now */
1312
1313 op = &reply_head->ops[0];
1314 opcode = le16_to_cpu(op->op);
1315 switch (opcode) {
1316 case CEPH_OSD_OP_READ:
1317 rbd_osd_read_callback(obj_request, op);
1318 break;
1319 case CEPH_OSD_OP_WRITE:
1320 rbd_osd_write_callback(obj_request, op);
1321 break;
Alex Elderfbfab532013-02-08 09:55:48 -06001322 case CEPH_OSD_OP_STAT:
1323 rbd_osd_stat_callback(obj_request, op);
1324 break;
Alex Elder36be9a72013-01-19 00:30:28 -06001325 case CEPH_OSD_OP_CALL:
Alex Elderb8d70032012-11-30 17:53:04 -06001326 case CEPH_OSD_OP_NOTIFY_ACK:
Alex Elder9969ebc2013-01-18 12:31:10 -06001327 case CEPH_OSD_OP_WATCH:
1328 rbd_osd_trivial_callback(obj_request, op);
1329 break;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001330 default:
1331 rbd_warn(NULL, "%s: unsupported op %hu\n",
1332 obj_request->object_name, (unsigned short) opcode);
1333 break;
1334 }
1335
Alex Elder07741302013-02-05 23:41:50 -06001336 if (obj_request_done_test(obj_request))
Alex Elderbf0d5f502012-11-22 00:00:08 -06001337 rbd_obj_request_complete(obj_request);
1338}
1339
1340static struct ceph_osd_request *rbd_osd_req_create(
1341 struct rbd_device *rbd_dev,
1342 bool write_request,
1343 struct rbd_obj_request *obj_request,
1344 struct ceph_osd_req_op *op)
1345{
1346 struct rbd_img_request *img_request = obj_request->img_request;
1347 struct ceph_snap_context *snapc = NULL;
1348 struct ceph_osd_client *osdc;
1349 struct ceph_osd_request *osd_req;
1350 struct timespec now;
1351 struct timespec *mtime;
1352 u64 snap_id = CEPH_NOSNAP;
1353 u64 offset = obj_request->offset;
1354 u64 length = obj_request->length;
1355
1356 if (img_request) {
1357 rbd_assert(img_request->write_request == write_request);
1358 if (img_request->write_request)
1359 snapc = img_request->snapc;
1360 else
1361 snap_id = img_request->snap_id;
1362 }
1363
1364 /* Allocate and initialize the request, for the single op */
1365
1366 osdc = &rbd_dev->rbd_client->client->osdc;
1367 osd_req = ceph_osdc_alloc_request(osdc, snapc, 1, false, GFP_ATOMIC);
1368 if (!osd_req)
1369 return NULL; /* ENOMEM */
1370
1371 rbd_assert(obj_request_type_valid(obj_request->type));
1372 switch (obj_request->type) {
Alex Elder9969ebc2013-01-18 12:31:10 -06001373 case OBJ_REQUEST_NODATA:
1374 break; /* Nothing to do */
Alex Elderbf0d5f502012-11-22 00:00:08 -06001375 case OBJ_REQUEST_BIO:
1376 rbd_assert(obj_request->bio_list != NULL);
1377 osd_req->r_bio = obj_request->bio_list;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001378 break;
Alex Elder788e2df2013-01-17 12:25:27 -06001379 case OBJ_REQUEST_PAGES:
1380 osd_req->r_pages = obj_request->pages;
1381 osd_req->r_num_pages = obj_request->page_count;
1382 osd_req->r_page_alignment = offset & ~PAGE_MASK;
1383 break;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001384 }
1385
1386 if (write_request) {
1387 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
1388 now = CURRENT_TIME;
1389 mtime = &now;
1390 } else {
1391 osd_req->r_flags = CEPH_OSD_FLAG_READ;
1392 mtime = NULL; /* not needed for reads */
1393 offset = 0; /* These are not used... */
1394 length = 0; /* ...for osd read requests */
1395 }
1396
1397 osd_req->r_callback = rbd_osd_req_callback;
1398 osd_req->r_priv = obj_request;
1399
1400 osd_req->r_oid_len = strlen(obj_request->object_name);
1401 rbd_assert(osd_req->r_oid_len < sizeof (osd_req->r_oid));
1402 memcpy(osd_req->r_oid, obj_request->object_name, osd_req->r_oid_len);
1403
1404 osd_req->r_file_layout = rbd_dev->layout; /* struct */
1405
1406 /* osd_req will get its own reference to snapc (if non-null) */
1407
1408 ceph_osdc_build_request(osd_req, offset, length, 1, op,
1409 snapc, snap_id, mtime);
1410
1411 return osd_req;
1412}
1413
1414static void rbd_osd_req_destroy(struct ceph_osd_request *osd_req)
1415{
1416 ceph_osdc_put_request(osd_req);
1417}
1418
1419/* object_name is assumed to be a non-null pointer and NUL-terminated */
1420
1421static struct rbd_obj_request *rbd_obj_request_create(const char *object_name,
1422 u64 offset, u64 length,
1423 enum obj_request_type type)
1424{
1425 struct rbd_obj_request *obj_request;
1426 size_t size;
1427 char *name;
1428
1429 rbd_assert(obj_request_type_valid(type));
1430
1431 size = strlen(object_name) + 1;
1432 obj_request = kzalloc(sizeof (*obj_request) + size, GFP_KERNEL);
1433 if (!obj_request)
1434 return NULL;
1435
1436 name = (char *)(obj_request + 1);
1437 obj_request->object_name = memcpy(name, object_name, size);
1438 obj_request->offset = offset;
1439 obj_request->length = length;
1440 obj_request->which = BAD_WHICH;
1441 obj_request->type = type;
1442 INIT_LIST_HEAD(&obj_request->links);
Alex Elder07741302013-02-05 23:41:50 -06001443 obj_request_done_init(obj_request);
Alex Elder788e2df2013-01-17 12:25:27 -06001444 init_completion(&obj_request->completion);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001445 kref_init(&obj_request->kref);
1446
1447 return obj_request;
1448}
1449
1450static void rbd_obj_request_destroy(struct kref *kref)
1451{
1452 struct rbd_obj_request *obj_request;
1453
1454 obj_request = container_of(kref, struct rbd_obj_request, kref);
1455
1456 rbd_assert(obj_request->img_request == NULL);
1457 rbd_assert(obj_request->which == BAD_WHICH);
1458
1459 if (obj_request->osd_req)
1460 rbd_osd_req_destroy(obj_request->osd_req);
1461
1462 rbd_assert(obj_request_type_valid(obj_request->type));
1463 switch (obj_request->type) {
Alex Elder9969ebc2013-01-18 12:31:10 -06001464 case OBJ_REQUEST_NODATA:
1465 break; /* Nothing to do */
Alex Elderbf0d5f502012-11-22 00:00:08 -06001466 case OBJ_REQUEST_BIO:
1467 if (obj_request->bio_list)
1468 bio_chain_put(obj_request->bio_list);
1469 break;
Alex Elder788e2df2013-01-17 12:25:27 -06001470 case OBJ_REQUEST_PAGES:
1471 if (obj_request->pages)
1472 ceph_release_page_vector(obj_request->pages,
1473 obj_request->page_count);
1474 break;
Alex Elderbf0d5f502012-11-22 00:00:08 -06001475 }
1476
1477 kfree(obj_request);
1478}
1479
1480/*
1481 * Caller is responsible for filling in the list of object requests
1482 * that comprises the image request, and the Linux request pointer
1483 * (if there is one).
1484 */
1485struct rbd_img_request *rbd_img_request_create(struct rbd_device *rbd_dev,
1486 u64 offset, u64 length,
1487 bool write_request)
1488{
1489 struct rbd_img_request *img_request;
1490 struct ceph_snap_context *snapc = NULL;
1491
1492 img_request = kmalloc(sizeof (*img_request), GFP_ATOMIC);
1493 if (!img_request)
1494 return NULL;
1495
1496 if (write_request) {
1497 down_read(&rbd_dev->header_rwsem);
1498 snapc = ceph_get_snap_context(rbd_dev->header.snapc);
1499 up_read(&rbd_dev->header_rwsem);
1500 if (WARN_ON(!snapc)) {
1501 kfree(img_request);
1502 return NULL; /* Shouldn't happen */
1503 }
1504 }
1505
1506 img_request->rq = NULL;
1507 img_request->rbd_dev = rbd_dev;
1508 img_request->offset = offset;
1509 img_request->length = length;
1510 img_request->write_request = write_request;
1511 if (write_request)
1512 img_request->snapc = snapc;
1513 else
1514 img_request->snap_id = rbd_dev->spec->snap_id;
1515 spin_lock_init(&img_request->completion_lock);
1516 img_request->next_completion = 0;
1517 img_request->callback = NULL;
1518 img_request->obj_request_count = 0;
1519 INIT_LIST_HEAD(&img_request->obj_requests);
1520 kref_init(&img_request->kref);
1521
1522 rbd_img_request_get(img_request); /* Avoid a warning */
1523 rbd_img_request_put(img_request); /* TEMPORARY */
1524
1525 return img_request;
1526}
1527
1528static void rbd_img_request_destroy(struct kref *kref)
1529{
1530 struct rbd_img_request *img_request;
1531 struct rbd_obj_request *obj_request;
1532 struct rbd_obj_request *next_obj_request;
1533
1534 img_request = container_of(kref, struct rbd_img_request, kref);
1535
1536 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
1537 rbd_img_obj_request_del(img_request, obj_request);
Alex Elder25dcf952013-01-25 17:08:55 -06001538 rbd_assert(img_request->obj_request_count == 0);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001539
1540 if (img_request->write_request)
1541 ceph_put_snap_context(img_request->snapc);
1542
1543 kfree(img_request);
1544}
1545
1546static int rbd_img_request_fill_bio(struct rbd_img_request *img_request,
1547 struct bio *bio_list)
1548{
1549 struct rbd_device *rbd_dev = img_request->rbd_dev;
1550 struct rbd_obj_request *obj_request = NULL;
1551 struct rbd_obj_request *next_obj_request;
1552 unsigned int bio_offset;
1553 u64 image_offset;
1554 u64 resid;
1555 u16 opcode;
1556
1557 opcode = img_request->write_request ? CEPH_OSD_OP_WRITE
1558 : CEPH_OSD_OP_READ;
1559 bio_offset = 0;
1560 image_offset = img_request->offset;
1561 rbd_assert(image_offset == bio_list->bi_sector << SECTOR_SHIFT);
1562 resid = img_request->length;
Alex Elder4dda41d2013-02-20 21:59:33 -06001563 rbd_assert(resid > 0);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001564 while (resid) {
1565 const char *object_name;
1566 unsigned int clone_size;
1567 struct ceph_osd_req_op *op;
1568 u64 offset;
1569 u64 length;
1570
1571 object_name = rbd_segment_name(rbd_dev, image_offset);
1572 if (!object_name)
1573 goto out_unwind;
1574 offset = rbd_segment_offset(rbd_dev, image_offset);
1575 length = rbd_segment_length(rbd_dev, image_offset, resid);
1576 obj_request = rbd_obj_request_create(object_name,
1577 offset, length,
1578 OBJ_REQUEST_BIO);
1579 kfree(object_name); /* object request has its own copy */
1580 if (!obj_request)
1581 goto out_unwind;
1582
1583 rbd_assert(length <= (u64) UINT_MAX);
1584 clone_size = (unsigned int) length;
1585 obj_request->bio_list = bio_chain_clone_range(&bio_list,
1586 &bio_offset, clone_size,
1587 GFP_ATOMIC);
1588 if (!obj_request->bio_list)
1589 goto out_partial;
1590
1591 /*
1592 * Build up the op to use in building the osd
1593 * request. Note that the contents of the op are
1594 * copied by rbd_osd_req_create().
1595 */
1596 op = rbd_osd_req_op_create(opcode, offset, length);
1597 if (!op)
1598 goto out_partial;
1599 obj_request->osd_req = rbd_osd_req_create(rbd_dev,
1600 img_request->write_request,
1601 obj_request, op);
1602 rbd_osd_req_op_destroy(op);
1603 if (!obj_request->osd_req)
1604 goto out_partial;
1605 /* status and version are initially zero-filled */
1606
1607 rbd_img_obj_request_add(img_request, obj_request);
1608
1609 image_offset += length;
1610 resid -= length;
1611 }
1612
1613 return 0;
1614
1615out_partial:
1616 rbd_obj_request_put(obj_request);
1617out_unwind:
1618 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
1619 rbd_obj_request_put(obj_request);
1620
1621 return -ENOMEM;
1622}
1623
1624static void rbd_img_obj_callback(struct rbd_obj_request *obj_request)
1625{
1626 struct rbd_img_request *img_request;
1627 u32 which = obj_request->which;
1628 bool more = true;
1629
1630 img_request = obj_request->img_request;
Alex Elder4dda41d2013-02-20 21:59:33 -06001631
Alex Elderbf0d5f502012-11-22 00:00:08 -06001632 rbd_assert(img_request != NULL);
1633 rbd_assert(img_request->rq != NULL);
Alex Elder4dda41d2013-02-20 21:59:33 -06001634 rbd_assert(img_request->obj_request_count > 0);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001635 rbd_assert(which != BAD_WHICH);
1636 rbd_assert(which < img_request->obj_request_count);
1637 rbd_assert(which >= img_request->next_completion);
1638
1639 spin_lock_irq(&img_request->completion_lock);
1640 if (which != img_request->next_completion)
1641 goto out;
1642
1643 for_each_obj_request_from(img_request, obj_request) {
1644 unsigned int xferred;
1645 int result;
1646
1647 rbd_assert(more);
1648 rbd_assert(which < img_request->obj_request_count);
1649
Alex Elder07741302013-02-05 23:41:50 -06001650 if (!obj_request_done_test(obj_request))
Alex Elderbf0d5f502012-11-22 00:00:08 -06001651 break;
1652
1653 rbd_assert(obj_request->xferred <= (u64) UINT_MAX);
1654 xferred = (unsigned int) obj_request->xferred;
1655 result = (int) obj_request->result;
1656 if (result)
1657 rbd_warn(NULL, "obj_request %s result %d xferred %u\n",
1658 img_request->write_request ? "write" : "read",
1659 result, xferred);
1660
1661 more = blk_end_request(img_request->rq, result, xferred);
1662 which++;
1663 }
1664 rbd_assert(more ^ (which == img_request->obj_request_count));
1665 img_request->next_completion = which;
1666out:
1667 spin_unlock_irq(&img_request->completion_lock);
1668
1669 if (!more)
1670 rbd_img_request_complete(img_request);
1671}
1672
1673static int rbd_img_request_submit(struct rbd_img_request *img_request)
1674{
1675 struct rbd_device *rbd_dev = img_request->rbd_dev;
1676 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
1677 struct rbd_obj_request *obj_request;
1678
1679 for_each_obj_request(img_request, obj_request) {
1680 int ret;
1681
1682 obj_request->callback = rbd_img_obj_callback;
1683 ret = rbd_obj_request_submit(osdc, obj_request);
1684 if (ret)
1685 return ret;
1686 /*
1687 * The image request has its own reference to each
1688 * of its object requests, so we can safely drop the
1689 * initial one here.
1690 */
1691 rbd_obj_request_put(obj_request);
1692 }
1693
1694 return 0;
1695}
1696
Alex Eldercf81b602013-01-17 12:18:46 -06001697static int rbd_obj_notify_ack(struct rbd_device *rbd_dev,
Alex Elderb8d70032012-11-30 17:53:04 -06001698 u64 ver, u64 notify_id)
1699{
1700 struct rbd_obj_request *obj_request;
1701 struct ceph_osd_req_op *op;
1702 struct ceph_osd_client *osdc;
1703 int ret;
1704
1705 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
1706 OBJ_REQUEST_NODATA);
1707 if (!obj_request)
1708 return -ENOMEM;
1709
1710 ret = -ENOMEM;
1711 op = rbd_osd_req_op_create(CEPH_OSD_OP_NOTIFY_ACK, notify_id, ver);
1712 if (!op)
1713 goto out;
1714 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false,
1715 obj_request, op);
1716 rbd_osd_req_op_destroy(op);
1717 if (!obj_request->osd_req)
1718 goto out;
1719
1720 osdc = &rbd_dev->rbd_client->client->osdc;
Alex Eldercf81b602013-01-17 12:18:46 -06001721 obj_request->callback = rbd_obj_request_put;
Alex Elderb8d70032012-11-30 17:53:04 -06001722 ret = rbd_obj_request_submit(osdc, obj_request);
Alex Elderb8d70032012-11-30 17:53:04 -06001723out:
Alex Eldercf81b602013-01-17 12:18:46 -06001724 if (ret)
1725 rbd_obj_request_put(obj_request);
Alex Elderb8d70032012-11-30 17:53:04 -06001726
1727 return ret;
1728}
1729
1730static void rbd_watch_cb(u64 ver, u64 notify_id, u8 opcode, void *data)
1731{
1732 struct rbd_device *rbd_dev = (struct rbd_device *)data;
1733 u64 hver;
1734 int rc;
1735
1736 if (!rbd_dev)
1737 return;
1738
1739 dout("rbd_watch_cb %s notify_id=%llu opcode=%u\n",
1740 rbd_dev->header_name, (unsigned long long) notify_id,
1741 (unsigned int) opcode);
1742 rc = rbd_dev_refresh(rbd_dev, &hver);
1743 if (rc)
1744 rbd_warn(rbd_dev, "got notification but failed to "
1745 " update snaps: %d\n", rc);
1746
Alex Eldercf81b602013-01-17 12:18:46 -06001747 rbd_obj_notify_ack(rbd_dev, hver, notify_id);
Alex Elderb8d70032012-11-30 17:53:04 -06001748}
1749
Alex Elder9969ebc2013-01-18 12:31:10 -06001750/*
1751 * Request sync osd watch/unwatch. The value of "start" determines
1752 * whether a watch request is being initiated or torn down.
1753 */
1754static int rbd_dev_header_watch_sync(struct rbd_device *rbd_dev, int start)
1755{
1756 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
1757 struct rbd_obj_request *obj_request;
1758 struct ceph_osd_req_op *op;
1759 int ret;
1760
1761 rbd_assert(start ^ !!rbd_dev->watch_event);
1762 rbd_assert(start ^ !!rbd_dev->watch_request);
1763
1764 if (start) {
Alex Elder3c663bb2013-02-15 11:42:30 -06001765 ret = ceph_osdc_create_event(osdc, rbd_watch_cb, rbd_dev,
Alex Elder9969ebc2013-01-18 12:31:10 -06001766 &rbd_dev->watch_event);
1767 if (ret < 0)
1768 return ret;
Alex Elder8eb87562013-01-25 17:08:55 -06001769 rbd_assert(rbd_dev->watch_event != NULL);
Alex Elder9969ebc2013-01-18 12:31:10 -06001770 }
1771
1772 ret = -ENOMEM;
1773 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
1774 OBJ_REQUEST_NODATA);
1775 if (!obj_request)
1776 goto out_cancel;
1777
1778 op = rbd_osd_req_op_create(CEPH_OSD_OP_WATCH,
1779 rbd_dev->watch_event->cookie,
1780 rbd_dev->header.obj_version, start);
1781 if (!op)
1782 goto out_cancel;
1783 obj_request->osd_req = rbd_osd_req_create(rbd_dev, true,
1784 obj_request, op);
1785 rbd_osd_req_op_destroy(op);
1786 if (!obj_request->osd_req)
1787 goto out_cancel;
1788
Alex Elder8eb87562013-01-25 17:08:55 -06001789 if (start)
Alex Elder975241a2013-01-25 17:08:55 -06001790 ceph_osdc_set_request_linger(osdc, obj_request->osd_req);
Alex Elder8eb87562013-01-25 17:08:55 -06001791 else
Alex Elder6977c3f2013-01-25 17:08:55 -06001792 ceph_osdc_unregister_linger_request(osdc,
Alex Elder975241a2013-01-25 17:08:55 -06001793 rbd_dev->watch_request->osd_req);
Alex Elder9969ebc2013-01-18 12:31:10 -06001794 ret = rbd_obj_request_submit(osdc, obj_request);
1795 if (ret)
1796 goto out_cancel;
1797 ret = rbd_obj_request_wait(obj_request);
1798 if (ret)
1799 goto out_cancel;
Alex Elder9969ebc2013-01-18 12:31:10 -06001800 ret = obj_request->result;
1801 if (ret)
1802 goto out_cancel;
1803
Alex Elder8eb87562013-01-25 17:08:55 -06001804 /*
1805 * A watch request is set to linger, so the underlying osd
1806 * request won't go away until we unregister it. We retain
1807 * a pointer to the object request during that time (in
1808 * rbd_dev->watch_request), so we'll keep a reference to
1809 * it. We'll drop that reference (below) after we've
1810 * unregistered it.
1811 */
1812 if (start) {
1813 rbd_dev->watch_request = obj_request;
1814
1815 return 0;
1816 }
1817
1818 /* We have successfully torn down the watch request */
1819
1820 rbd_obj_request_put(rbd_dev->watch_request);
1821 rbd_dev->watch_request = NULL;
Alex Elder9969ebc2013-01-18 12:31:10 -06001822out_cancel:
1823 /* Cancel the event if we're tearing down, or on error */
1824 ceph_osdc_cancel_event(rbd_dev->watch_event);
1825 rbd_dev->watch_event = NULL;
Alex Elder9969ebc2013-01-18 12:31:10 -06001826 if (obj_request)
1827 rbd_obj_request_put(obj_request);
1828
1829 return ret;
1830}
1831
Alex Elder36be9a72013-01-19 00:30:28 -06001832/*
1833 * Synchronous osd object method call
1834 */
1835static int rbd_obj_method_sync(struct rbd_device *rbd_dev,
1836 const char *object_name,
1837 const char *class_name,
1838 const char *method_name,
1839 const char *outbound,
1840 size_t outbound_size,
1841 char *inbound,
1842 size_t inbound_size,
1843 u64 *version)
1844{
1845 struct rbd_obj_request *obj_request;
1846 struct ceph_osd_client *osdc;
1847 struct ceph_osd_req_op *op;
1848 struct page **pages;
1849 u32 page_count;
1850 int ret;
1851
1852 /*
1853 * Method calls are ultimately read operations but they
1854 * don't involve object data (so no offset or length).
1855 * The result should placed into the inbound buffer
1856 * provided. They also supply outbound data--parameters for
1857 * the object method. Currently if this is present it will
1858 * be a snapshot id.
1859 */
1860 page_count = (u32) calc_pages_for(0, inbound_size);
1861 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
1862 if (IS_ERR(pages))
1863 return PTR_ERR(pages);
1864
1865 ret = -ENOMEM;
1866 obj_request = rbd_obj_request_create(object_name, 0, 0,
1867 OBJ_REQUEST_PAGES);
1868 if (!obj_request)
1869 goto out;
1870
1871 obj_request->pages = pages;
1872 obj_request->page_count = page_count;
1873
1874 op = rbd_osd_req_op_create(CEPH_OSD_OP_CALL, class_name,
1875 method_name, outbound, outbound_size);
1876 if (!op)
1877 goto out;
1878 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false,
1879 obj_request, op);
1880 rbd_osd_req_op_destroy(op);
1881 if (!obj_request->osd_req)
1882 goto out;
1883
1884 osdc = &rbd_dev->rbd_client->client->osdc;
1885 ret = rbd_obj_request_submit(osdc, obj_request);
1886 if (ret)
1887 goto out;
1888 ret = rbd_obj_request_wait(obj_request);
1889 if (ret)
1890 goto out;
1891
1892 ret = obj_request->result;
1893 if (ret < 0)
1894 goto out;
Alex Elder23ed6e12013-02-06 13:11:38 -06001895 ret = 0;
Alex Elder903bb322013-02-06 13:11:38 -06001896 ceph_copy_from_page_vector(pages, inbound, 0, obj_request->xferred);
Alex Elder36be9a72013-01-19 00:30:28 -06001897 if (version)
1898 *version = obj_request->version;
1899out:
1900 if (obj_request)
1901 rbd_obj_request_put(obj_request);
1902 else
1903 ceph_release_page_vector(pages, page_count);
1904
1905 return ret;
1906}
1907
Alex Elderbf0d5f502012-11-22 00:00:08 -06001908static void rbd_request_fn(struct request_queue *q)
1909{
1910 struct rbd_device *rbd_dev = q->queuedata;
1911 bool read_only = rbd_dev->mapping.read_only;
1912 struct request *rq;
1913 int result;
1914
1915 while ((rq = blk_fetch_request(q))) {
1916 bool write_request = rq_data_dir(rq) == WRITE;
1917 struct rbd_img_request *img_request;
1918 u64 offset;
1919 u64 length;
1920
1921 /* Ignore any non-FS requests that filter through. */
1922
1923 if (rq->cmd_type != REQ_TYPE_FS) {
Alex Elder4dda41d2013-02-20 21:59:33 -06001924 dout("%s: non-fs request type %d\n", __func__,
1925 (int) rq->cmd_type);
1926 __blk_end_request_all(rq, 0);
1927 continue;
1928 }
1929
1930 /* Ignore/skip any zero-length requests */
1931
1932 offset = (u64) blk_rq_pos(rq) << SECTOR_SHIFT;
1933 length = (u64) blk_rq_bytes(rq);
1934
1935 if (!length) {
1936 dout("%s: zero-length request\n", __func__);
Alex Elderbf0d5f502012-11-22 00:00:08 -06001937 __blk_end_request_all(rq, 0);
1938 continue;
1939 }
1940
1941 spin_unlock_irq(q->queue_lock);
1942
1943 /* Disallow writes to a read-only device */
1944
1945 if (write_request) {
1946 result = -EROFS;
1947 if (read_only)
1948 goto end_request;
1949 rbd_assert(rbd_dev->spec->snap_id == CEPH_NOSNAP);
1950 }
1951
Alex Elder6d292902013-01-14 12:43:31 -06001952 /*
1953 * Quit early if the mapped snapshot no longer
1954 * exists. It's still possible the snapshot will
1955 * have disappeared by the time our request arrives
1956 * at the osd, but there's no sense in sending it if
1957 * we already know.
1958 */
1959 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags)) {
Alex Elderbf0d5f502012-11-22 00:00:08 -06001960 dout("request for non-existent snapshot");
1961 rbd_assert(rbd_dev->spec->snap_id != CEPH_NOSNAP);
1962 result = -ENXIO;
1963 goto end_request;
1964 }
1965
Alex Elderbf0d5f502012-11-22 00:00:08 -06001966 result = -EINVAL;
1967 if (WARN_ON(offset && length > U64_MAX - offset + 1))
1968 goto end_request; /* Shouldn't happen */
1969
1970 result = -ENOMEM;
1971 img_request = rbd_img_request_create(rbd_dev, offset, length,
1972 write_request);
1973 if (!img_request)
1974 goto end_request;
1975
1976 img_request->rq = rq;
1977
1978 result = rbd_img_request_fill_bio(img_request, rq->bio);
1979 if (!result)
1980 result = rbd_img_request_submit(img_request);
1981 if (result)
1982 rbd_img_request_put(img_request);
1983end_request:
1984 spin_lock_irq(q->queue_lock);
1985 if (result < 0) {
1986 rbd_warn(rbd_dev, "obj_request %s result %d\n",
1987 write_request ? "write" : "read", result);
1988 __blk_end_request_all(rq, result);
1989 }
1990 }
1991}
1992
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001993/*
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001994 * a queue callback. Makes sure that we don't create a bio that spans across
1995 * multiple osd objects. One exception would be with a single page bios,
Alex Elderf7760da2012-10-20 22:17:27 -05001996 * which we handle later at bio_chain_clone_range()
Yehuda Sadeh602adf42010-08-12 16:11:25 -07001997 */
1998static int rbd_merge_bvec(struct request_queue *q, struct bvec_merge_data *bmd,
1999 struct bio_vec *bvec)
2000{
2001 struct rbd_device *rbd_dev = q->queuedata;
Alex Eldere5cfeed2012-10-20 22:17:27 -05002002 sector_t sector_offset;
2003 sector_t sectors_per_obj;
2004 sector_t obj_sector_offset;
2005 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002006
Alex Eldere5cfeed2012-10-20 22:17:27 -05002007 /*
2008 * Find how far into its rbd object the partition-relative
2009 * bio start sector is to offset relative to the enclosing
2010 * device.
2011 */
2012 sector_offset = get_start_sect(bmd->bi_bdev) + bmd->bi_sector;
2013 sectors_per_obj = 1 << (rbd_dev->header.obj_order - SECTOR_SHIFT);
2014 obj_sector_offset = sector_offset & (sectors_per_obj - 1);
Alex Elder593a9e72012-02-07 12:03:37 -06002015
Alex Eldere5cfeed2012-10-20 22:17:27 -05002016 /*
2017 * Compute the number of bytes from that offset to the end
2018 * of the object. Account for what's already used by the bio.
2019 */
2020 ret = (int) (sectors_per_obj - obj_sector_offset) << SECTOR_SHIFT;
2021 if (ret > bmd->bi_size)
2022 ret -= bmd->bi_size;
2023 else
2024 ret = 0;
2025
2026 /*
2027 * Don't send back more than was asked for. And if the bio
2028 * was empty, let the whole thing through because: "Note
2029 * that a block device *must* allow a single page to be
2030 * added to an empty bio."
2031 */
2032 rbd_assert(bvec->bv_len <= PAGE_SIZE);
2033 if (ret > (int) bvec->bv_len || !bmd->bi_size)
2034 ret = (int) bvec->bv_len;
2035
2036 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002037}
2038
2039static void rbd_free_disk(struct rbd_device *rbd_dev)
2040{
2041 struct gendisk *disk = rbd_dev->disk;
2042
2043 if (!disk)
2044 return;
2045
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002046 if (disk->flags & GENHD_FL_UP)
2047 del_gendisk(disk);
2048 if (disk->queue)
2049 blk_cleanup_queue(disk->queue);
2050 put_disk(disk);
2051}
2052
Alex Elder788e2df2013-01-17 12:25:27 -06002053static int rbd_obj_read_sync(struct rbd_device *rbd_dev,
2054 const char *object_name,
2055 u64 offset, u64 length,
2056 char *buf, u64 *version)
2057
2058{
2059 struct ceph_osd_req_op *op;
2060 struct rbd_obj_request *obj_request;
2061 struct ceph_osd_client *osdc;
2062 struct page **pages = NULL;
2063 u32 page_count;
Alex Elder1ceae7e2013-02-06 13:11:38 -06002064 size_t size;
Alex Elder788e2df2013-01-17 12:25:27 -06002065 int ret;
2066
2067 page_count = (u32) calc_pages_for(offset, length);
2068 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2069 if (IS_ERR(pages))
2070 ret = PTR_ERR(pages);
2071
2072 ret = -ENOMEM;
2073 obj_request = rbd_obj_request_create(object_name, offset, length,
Alex Elder36be9a72013-01-19 00:30:28 -06002074 OBJ_REQUEST_PAGES);
Alex Elder788e2df2013-01-17 12:25:27 -06002075 if (!obj_request)
2076 goto out;
2077
2078 obj_request->pages = pages;
2079 obj_request->page_count = page_count;
2080
2081 op = rbd_osd_req_op_create(CEPH_OSD_OP_READ, offset, length);
2082 if (!op)
2083 goto out;
2084 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false,
2085 obj_request, op);
2086 rbd_osd_req_op_destroy(op);
2087 if (!obj_request->osd_req)
2088 goto out;
2089
2090 osdc = &rbd_dev->rbd_client->client->osdc;
2091 ret = rbd_obj_request_submit(osdc, obj_request);
2092 if (ret)
2093 goto out;
2094 ret = rbd_obj_request_wait(obj_request);
2095 if (ret)
2096 goto out;
2097
2098 ret = obj_request->result;
2099 if (ret < 0)
2100 goto out;
Alex Elder1ceae7e2013-02-06 13:11:38 -06002101
2102 rbd_assert(obj_request->xferred <= (u64) SIZE_MAX);
2103 size = (size_t) obj_request->xferred;
Alex Elder903bb322013-02-06 13:11:38 -06002104 ceph_copy_from_page_vector(pages, buf, 0, size);
Alex Elder23ed6e12013-02-06 13:11:38 -06002105 rbd_assert(size <= (size_t) INT_MAX);
2106 ret = (int) size;
Alex Elder788e2df2013-01-17 12:25:27 -06002107 if (version)
2108 *version = obj_request->version;
2109out:
2110 if (obj_request)
2111 rbd_obj_request_put(obj_request);
2112 else
2113 ceph_release_page_vector(pages, page_count);
2114
2115 return ret;
2116}
2117
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002118/*
Alex Elder4156d992012-08-02 11:29:46 -05002119 * Read the complete header for the given rbd device.
2120 *
2121 * Returns a pointer to a dynamically-allocated buffer containing
2122 * the complete and validated header. Caller can pass the address
2123 * of a variable that will be filled in with the version of the
2124 * header object at the time it was read.
2125 *
2126 * Returns a pointer-coded errno if a failure occurs.
2127 */
2128static struct rbd_image_header_ondisk *
2129rbd_dev_v1_header_read(struct rbd_device *rbd_dev, u64 *version)
2130{
2131 struct rbd_image_header_ondisk *ondisk = NULL;
2132 u32 snap_count = 0;
2133 u64 names_size = 0;
2134 u32 want_count;
2135 int ret;
2136
2137 /*
2138 * The complete header will include an array of its 64-bit
2139 * snapshot ids, followed by the names of those snapshots as
2140 * a contiguous block of NUL-terminated strings. Note that
2141 * the number of snapshots could change by the time we read
2142 * it in, in which case we re-read it.
2143 */
2144 do {
2145 size_t size;
2146
2147 kfree(ondisk);
2148
2149 size = sizeof (*ondisk);
2150 size += snap_count * sizeof (struct rbd_image_snap_ondisk);
2151 size += names_size;
2152 ondisk = kmalloc(size, GFP_KERNEL);
2153 if (!ondisk)
2154 return ERR_PTR(-ENOMEM);
2155
Alex Elder788e2df2013-01-17 12:25:27 -06002156 ret = rbd_obj_read_sync(rbd_dev, rbd_dev->header_name,
Alex Elder4156d992012-08-02 11:29:46 -05002157 0, size,
2158 (char *) ondisk, version);
Alex Elder4156d992012-08-02 11:29:46 -05002159 if (ret < 0)
2160 goto out_err;
2161 if (WARN_ON((size_t) ret < size)) {
2162 ret = -ENXIO;
Alex Elder06ecc6c2012-11-01 10:17:15 -05002163 rbd_warn(rbd_dev, "short header read (want %zd got %d)",
2164 size, ret);
Alex Elder4156d992012-08-02 11:29:46 -05002165 goto out_err;
2166 }
2167 if (!rbd_dev_ondisk_valid(ondisk)) {
2168 ret = -ENXIO;
Alex Elder06ecc6c2012-11-01 10:17:15 -05002169 rbd_warn(rbd_dev, "invalid header");
Alex Elder4156d992012-08-02 11:29:46 -05002170 goto out_err;
2171 }
2172
2173 names_size = le64_to_cpu(ondisk->snap_names_len);
2174 want_count = snap_count;
2175 snap_count = le32_to_cpu(ondisk->snap_count);
2176 } while (snap_count != want_count);
2177
2178 return ondisk;
2179
2180out_err:
2181 kfree(ondisk);
2182
2183 return ERR_PTR(ret);
2184}
2185
2186/*
2187 * reload the ondisk the header
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002188 */
2189static int rbd_read_header(struct rbd_device *rbd_dev,
2190 struct rbd_image_header *header)
2191{
Alex Elder4156d992012-08-02 11:29:46 -05002192 struct rbd_image_header_ondisk *ondisk;
2193 u64 ver = 0;
2194 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002195
Alex Elder4156d992012-08-02 11:29:46 -05002196 ondisk = rbd_dev_v1_header_read(rbd_dev, &ver);
2197 if (IS_ERR(ondisk))
2198 return PTR_ERR(ondisk);
2199 ret = rbd_header_from_disk(header, ondisk);
2200 if (ret >= 0)
2201 header->obj_version = ver;
2202 kfree(ondisk);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002203
Alex Elder4156d992012-08-02 11:29:46 -05002204 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002205}
2206
Alex Elder41f38c22012-10-25 23:34:40 -05002207static void rbd_remove_all_snaps(struct rbd_device *rbd_dev)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002208{
2209 struct rbd_snap *snap;
Alex Eldera0593292012-07-19 09:09:27 -05002210 struct rbd_snap *next;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002211
Alex Eldera0593292012-07-19 09:09:27 -05002212 list_for_each_entry_safe(snap, next, &rbd_dev->snaps, node)
Alex Elder41f38c22012-10-25 23:34:40 -05002213 rbd_remove_snap_dev(snap);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002214}
2215
Alex Elder94785542012-10-09 13:50:17 -07002216static void rbd_update_mapping_size(struct rbd_device *rbd_dev)
2217{
2218 sector_t size;
2219
Alex Elder0d7dbfc2012-10-25 23:34:41 -05002220 if (rbd_dev->spec->snap_id != CEPH_NOSNAP)
Alex Elder94785542012-10-09 13:50:17 -07002221 return;
2222
2223 size = (sector_t) rbd_dev->header.image_size / SECTOR_SIZE;
2224 dout("setting size to %llu sectors", (unsigned long long) size);
2225 rbd_dev->mapping.size = (u64) size;
2226 set_capacity(rbd_dev->disk, size);
2227}
2228
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002229/*
2230 * only read the first part of the ondisk header, without the snaps info
2231 */
Alex Elder117973f2012-08-31 17:29:55 -05002232static int rbd_dev_v1_refresh(struct rbd_device *rbd_dev, u64 *hver)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002233{
2234 int ret;
2235 struct rbd_image_header h;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002236
2237 ret = rbd_read_header(rbd_dev, &h);
2238 if (ret < 0)
2239 return ret;
2240
Josh Durgina51aa0c2011-12-05 10:35:04 -08002241 down_write(&rbd_dev->header_rwsem);
2242
Alex Elder94785542012-10-09 13:50:17 -07002243 /* Update image size, and check for resize of mapped image */
2244 rbd_dev->header.image_size = h.image_size;
2245 rbd_update_mapping_size(rbd_dev);
Sage Weil9db4b3e2011-04-19 22:49:06 -07002246
Alex Elder849b4262012-07-09 21:04:24 -05002247 /* rbd_dev->header.object_prefix shouldn't change */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002248 kfree(rbd_dev->header.snap_sizes);
Alex Elder849b4262012-07-09 21:04:24 -05002249 kfree(rbd_dev->header.snap_names);
Josh Durgind1d25642011-12-05 14:03:05 -08002250 /* osd requests may still refer to snapc */
2251 ceph_put_snap_context(rbd_dev->header.snapc);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002252
Alex Elderb8136232012-07-25 09:32:41 -05002253 if (hver)
2254 *hver = h.obj_version;
Josh Durgina71b8912011-12-05 18:10:44 -08002255 rbd_dev->header.obj_version = h.obj_version;
Josh Durgin93a24e02011-12-05 10:41:28 -08002256 rbd_dev->header.image_size = h.image_size;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002257 rbd_dev->header.snapc = h.snapc;
2258 rbd_dev->header.snap_names = h.snap_names;
2259 rbd_dev->header.snap_sizes = h.snap_sizes;
Alex Elder849b4262012-07-09 21:04:24 -05002260 /* Free the extra copy of the object prefix */
2261 WARN_ON(strcmp(rbd_dev->header.object_prefix, h.object_prefix));
2262 kfree(h.object_prefix);
2263
Alex Elder304f6802012-08-31 17:29:52 -05002264 ret = rbd_dev_snaps_update(rbd_dev);
2265 if (!ret)
2266 ret = rbd_dev_snaps_register(rbd_dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002267
Josh Durginc6666012011-11-21 17:11:12 -08002268 up_write(&rbd_dev->header_rwsem);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002269
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002270 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002271}
2272
Alex Elder117973f2012-08-31 17:29:55 -05002273static int rbd_dev_refresh(struct rbd_device *rbd_dev, u64 *hver)
Alex Elder1fe5e992012-07-25 09:32:41 -05002274{
2275 int ret;
2276
Alex Elder117973f2012-08-31 17:29:55 -05002277 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
Alex Elder1fe5e992012-07-25 09:32:41 -05002278 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Alex Elder117973f2012-08-31 17:29:55 -05002279 if (rbd_dev->image_format == 1)
2280 ret = rbd_dev_v1_refresh(rbd_dev, hver);
2281 else
2282 ret = rbd_dev_v2_refresh(rbd_dev, hver);
Alex Elder1fe5e992012-07-25 09:32:41 -05002283 mutex_unlock(&ctl_mutex);
2284
2285 return ret;
2286}
2287
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002288static int rbd_init_disk(struct rbd_device *rbd_dev)
2289{
2290 struct gendisk *disk;
2291 struct request_queue *q;
Alex Elder593a9e72012-02-07 12:03:37 -06002292 u64 segment_size;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002293
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002294 /* create gendisk info */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002295 disk = alloc_disk(RBD_MINORS_PER_MAJOR);
2296 if (!disk)
Alex Elder1fcdb8a2012-08-29 17:11:06 -05002297 return -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002298
Alex Elderf0f8cef2012-01-29 13:57:44 -06002299 snprintf(disk->disk_name, sizeof(disk->disk_name), RBD_DRV_NAME "%d",
Alex Elderde71a292012-07-03 16:01:19 -05002300 rbd_dev->dev_id);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002301 disk->major = rbd_dev->major;
2302 disk->first_minor = 0;
2303 disk->fops = &rbd_bd_ops;
2304 disk->private_data = rbd_dev;
2305
Alex Elderbf0d5f502012-11-22 00:00:08 -06002306 q = blk_init_queue(rbd_request_fn, &rbd_dev->lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002307 if (!q)
2308 goto out_disk;
Josh Durgin029bcbd2011-07-22 11:35:23 -07002309
Alex Elder593a9e72012-02-07 12:03:37 -06002310 /* We use the default size, but let's be explicit about it. */
2311 blk_queue_physical_block_size(q, SECTOR_SIZE);
2312
Josh Durgin029bcbd2011-07-22 11:35:23 -07002313 /* set io sizes to object size */
Alex Elder593a9e72012-02-07 12:03:37 -06002314 segment_size = rbd_obj_bytes(&rbd_dev->header);
2315 blk_queue_max_hw_sectors(q, segment_size / SECTOR_SIZE);
2316 blk_queue_max_segment_size(q, segment_size);
2317 blk_queue_io_min(q, segment_size);
2318 blk_queue_io_opt(q, segment_size);
Josh Durgin029bcbd2011-07-22 11:35:23 -07002319
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002320 blk_queue_merge_bvec(q, rbd_merge_bvec);
2321 disk->queue = q;
2322
2323 q->queuedata = rbd_dev;
2324
2325 rbd_dev->disk = disk;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002326
Alex Elder12f02942012-08-29 17:11:07 -05002327 set_capacity(rbd_dev->disk, rbd_dev->mapping.size / SECTOR_SIZE);
2328
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002329 return 0;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002330out_disk:
2331 put_disk(disk);
Alex Elder1fcdb8a2012-08-29 17:11:06 -05002332
2333 return -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002334}
2335
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002336/*
2337 sysfs
2338*/
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002339
Alex Elder593a9e72012-02-07 12:03:37 -06002340static struct rbd_device *dev_to_rbd_dev(struct device *dev)
2341{
2342 return container_of(dev, struct rbd_device, dev);
2343}
2344
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002345static ssize_t rbd_size_show(struct device *dev,
2346 struct device_attribute *attr, char *buf)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002347{
Alex Elder593a9e72012-02-07 12:03:37 -06002348 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Josh Durgina51aa0c2011-12-05 10:35:04 -08002349 sector_t size;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002350
Josh Durgina51aa0c2011-12-05 10:35:04 -08002351 down_read(&rbd_dev->header_rwsem);
2352 size = get_capacity(rbd_dev->disk);
2353 up_read(&rbd_dev->header_rwsem);
2354
2355 return sprintf(buf, "%llu\n", (unsigned long long) size * SECTOR_SIZE);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002356}
2357
Alex Elder34b13182012-07-13 20:35:12 -05002358/*
2359 * Note this shows the features for whatever's mapped, which is not
2360 * necessarily the base image.
2361 */
2362static ssize_t rbd_features_show(struct device *dev,
2363 struct device_attribute *attr, char *buf)
2364{
2365 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2366
2367 return sprintf(buf, "0x%016llx\n",
2368 (unsigned long long) rbd_dev->mapping.features);
2369}
2370
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002371static ssize_t rbd_major_show(struct device *dev,
2372 struct device_attribute *attr, char *buf)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002373{
Alex Elder593a9e72012-02-07 12:03:37 -06002374 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002375
2376 return sprintf(buf, "%d\n", rbd_dev->major);
2377}
2378
2379static ssize_t rbd_client_id_show(struct device *dev,
2380 struct device_attribute *attr, char *buf)
2381{
Alex Elder593a9e72012-02-07 12:03:37 -06002382 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002383
Alex Elder1dbb4392012-01-24 10:08:37 -06002384 return sprintf(buf, "client%lld\n",
2385 ceph_client_id(rbd_dev->rbd_client->client));
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002386}
2387
2388static ssize_t rbd_pool_show(struct device *dev,
2389 struct device_attribute *attr, char *buf)
2390{
Alex Elder593a9e72012-02-07 12:03:37 -06002391 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002392
Alex Elder0d7dbfc2012-10-25 23:34:41 -05002393 return sprintf(buf, "%s\n", rbd_dev->spec->pool_name);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002394}
2395
Alex Elder9bb2f332012-07-12 10:46:35 -05002396static ssize_t rbd_pool_id_show(struct device *dev,
2397 struct device_attribute *attr, char *buf)
2398{
2399 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2400
Alex Elder0d7dbfc2012-10-25 23:34:41 -05002401 return sprintf(buf, "%llu\n",
2402 (unsigned long long) rbd_dev->spec->pool_id);
Alex Elder9bb2f332012-07-12 10:46:35 -05002403}
2404
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002405static ssize_t rbd_name_show(struct device *dev,
2406 struct device_attribute *attr, char *buf)
2407{
Alex Elder593a9e72012-02-07 12:03:37 -06002408 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002409
Alex Eldera92ffdf2012-10-30 19:40:33 -05002410 if (rbd_dev->spec->image_name)
2411 return sprintf(buf, "%s\n", rbd_dev->spec->image_name);
2412
2413 return sprintf(buf, "(unknown)\n");
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002414}
2415
Alex Elder589d30e2012-07-10 20:30:11 -05002416static ssize_t rbd_image_id_show(struct device *dev,
2417 struct device_attribute *attr, char *buf)
2418{
2419 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2420
Alex Elder0d7dbfc2012-10-25 23:34:41 -05002421 return sprintf(buf, "%s\n", rbd_dev->spec->image_id);
Alex Elder589d30e2012-07-10 20:30:11 -05002422}
2423
Alex Elder34b13182012-07-13 20:35:12 -05002424/*
2425 * Shows the name of the currently-mapped snapshot (or
2426 * RBD_SNAP_HEAD_NAME for the base image).
2427 */
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002428static ssize_t rbd_snap_show(struct device *dev,
2429 struct device_attribute *attr,
2430 char *buf)
2431{
Alex Elder593a9e72012-02-07 12:03:37 -06002432 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002433
Alex Elder0d7dbfc2012-10-25 23:34:41 -05002434 return sprintf(buf, "%s\n", rbd_dev->spec->snap_name);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002435}
2436
Alex Elder86b00e02012-10-25 23:34:42 -05002437/*
2438 * For an rbd v2 image, shows the pool id, image id, and snapshot id
2439 * for the parent image. If there is no parent, simply shows
2440 * "(no parent image)".
2441 */
2442static ssize_t rbd_parent_show(struct device *dev,
2443 struct device_attribute *attr,
2444 char *buf)
2445{
2446 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2447 struct rbd_spec *spec = rbd_dev->parent_spec;
2448 int count;
2449 char *bufp = buf;
2450
2451 if (!spec)
2452 return sprintf(buf, "(no parent image)\n");
2453
2454 count = sprintf(bufp, "pool_id %llu\npool_name %s\n",
2455 (unsigned long long) spec->pool_id, spec->pool_name);
2456 if (count < 0)
2457 return count;
2458 bufp += count;
2459
2460 count = sprintf(bufp, "image_id %s\nimage_name %s\n", spec->image_id,
2461 spec->image_name ? spec->image_name : "(unknown)");
2462 if (count < 0)
2463 return count;
2464 bufp += count;
2465
2466 count = sprintf(bufp, "snap_id %llu\nsnap_name %s\n",
2467 (unsigned long long) spec->snap_id, spec->snap_name);
2468 if (count < 0)
2469 return count;
2470 bufp += count;
2471
2472 count = sprintf(bufp, "overlap %llu\n", rbd_dev->parent_overlap);
2473 if (count < 0)
2474 return count;
2475 bufp += count;
2476
2477 return (ssize_t) (bufp - buf);
2478}
2479
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002480static ssize_t rbd_image_refresh(struct device *dev,
2481 struct device_attribute *attr,
2482 const char *buf,
2483 size_t size)
2484{
Alex Elder593a9e72012-02-07 12:03:37 -06002485 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Alex Elderb8136232012-07-25 09:32:41 -05002486 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002487
Alex Elder117973f2012-08-31 17:29:55 -05002488 ret = rbd_dev_refresh(rbd_dev, NULL);
Alex Elderb8136232012-07-25 09:32:41 -05002489
2490 return ret < 0 ? ret : size;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002491}
Yehuda Sadeh602adf42010-08-12 16:11:25 -07002492
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002493static DEVICE_ATTR(size, S_IRUGO, rbd_size_show, NULL);
Alex Elder34b13182012-07-13 20:35:12 -05002494static DEVICE_ATTR(features, S_IRUGO, rbd_features_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002495static DEVICE_ATTR(major, S_IRUGO, rbd_major_show, NULL);
2496static DEVICE_ATTR(client_id, S_IRUGO, rbd_client_id_show, NULL);
2497static DEVICE_ATTR(pool, S_IRUGO, rbd_pool_show, NULL);
Alex Elder9bb2f332012-07-12 10:46:35 -05002498static DEVICE_ATTR(pool_id, S_IRUGO, rbd_pool_id_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002499static DEVICE_ATTR(name, S_IRUGO, rbd_name_show, NULL);
Alex Elder589d30e2012-07-10 20:30:11 -05002500static DEVICE_ATTR(image_id, S_IRUGO, rbd_image_id_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002501static DEVICE_ATTR(refresh, S_IWUSR, NULL, rbd_image_refresh);
2502static DEVICE_ATTR(current_snap, S_IRUGO, rbd_snap_show, NULL);
Alex Elder86b00e02012-10-25 23:34:42 -05002503static DEVICE_ATTR(parent, S_IRUGO, rbd_parent_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002504
2505static struct attribute *rbd_attrs[] = {
2506 &dev_attr_size.attr,
Alex Elder34b13182012-07-13 20:35:12 -05002507 &dev_attr_features.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002508 &dev_attr_major.attr,
2509 &dev_attr_client_id.attr,
2510 &dev_attr_pool.attr,
Alex Elder9bb2f332012-07-12 10:46:35 -05002511 &dev_attr_pool_id.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002512 &dev_attr_name.attr,
Alex Elder589d30e2012-07-10 20:30:11 -05002513 &dev_attr_image_id.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002514 &dev_attr_current_snap.attr,
Alex Elder86b00e02012-10-25 23:34:42 -05002515 &dev_attr_parent.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002516 &dev_attr_refresh.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002517 NULL
2518};
2519
2520static struct attribute_group rbd_attr_group = {
2521 .attrs = rbd_attrs,
2522};
2523
2524static const struct attribute_group *rbd_attr_groups[] = {
2525 &rbd_attr_group,
2526 NULL
2527};
2528
2529static void rbd_sysfs_dev_release(struct device *dev)
2530{
2531}
2532
2533static struct device_type rbd_device_type = {
2534 .name = "rbd",
2535 .groups = rbd_attr_groups,
2536 .release = rbd_sysfs_dev_release,
2537};
2538
2539
2540/*
2541 sysfs - snapshots
2542*/
2543
2544static ssize_t rbd_snap_size_show(struct device *dev,
2545 struct device_attribute *attr,
2546 char *buf)
2547{
2548 struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);
2549
Josh Durgin35915382011-12-05 18:25:13 -08002550 return sprintf(buf, "%llu\n", (unsigned long long)snap->size);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002551}
2552
2553static ssize_t rbd_snap_id_show(struct device *dev,
2554 struct device_attribute *attr,
2555 char *buf)
2556{
2557 struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);
2558
Josh Durgin35915382011-12-05 18:25:13 -08002559 return sprintf(buf, "%llu\n", (unsigned long long)snap->id);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002560}
2561
Alex Elder34b13182012-07-13 20:35:12 -05002562static ssize_t rbd_snap_features_show(struct device *dev,
2563 struct device_attribute *attr,
2564 char *buf)
2565{
2566 struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);
2567
2568 return sprintf(buf, "0x%016llx\n",
2569 (unsigned long long) snap->features);
2570}
2571
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002572static DEVICE_ATTR(snap_size, S_IRUGO, rbd_snap_size_show, NULL);
2573static DEVICE_ATTR(snap_id, S_IRUGO, rbd_snap_id_show, NULL);
Alex Elder34b13182012-07-13 20:35:12 -05002574static DEVICE_ATTR(snap_features, S_IRUGO, rbd_snap_features_show, NULL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002575
2576static struct attribute *rbd_snap_attrs[] = {
2577 &dev_attr_snap_size.attr,
2578 &dev_attr_snap_id.attr,
Alex Elder34b13182012-07-13 20:35:12 -05002579 &dev_attr_snap_features.attr,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002580 NULL,
2581};
2582
2583static struct attribute_group rbd_snap_attr_group = {
2584 .attrs = rbd_snap_attrs,
2585};
2586
2587static void rbd_snap_dev_release(struct device *dev)
2588{
2589 struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);
2590 kfree(snap->name);
2591 kfree(snap);
2592}
2593
2594static const struct attribute_group *rbd_snap_attr_groups[] = {
2595 &rbd_snap_attr_group,
2596 NULL
2597};
2598
2599static struct device_type rbd_snap_device_type = {
2600 .groups = rbd_snap_attr_groups,
2601 .release = rbd_snap_dev_release,
2602};
2603
Alex Elder8b8fb992012-10-26 17:25:24 -05002604static struct rbd_spec *rbd_spec_get(struct rbd_spec *spec)
2605{
2606 kref_get(&spec->kref);
2607
2608 return spec;
2609}
2610
2611static void rbd_spec_free(struct kref *kref);
2612static void rbd_spec_put(struct rbd_spec *spec)
2613{
2614 if (spec)
2615 kref_put(&spec->kref, rbd_spec_free);
2616}
2617
2618static struct rbd_spec *rbd_spec_alloc(void)
2619{
2620 struct rbd_spec *spec;
2621
2622 spec = kzalloc(sizeof (*spec), GFP_KERNEL);
2623 if (!spec)
2624 return NULL;
2625 kref_init(&spec->kref);
2626
2627 rbd_spec_put(rbd_spec_get(spec)); /* TEMPORARY */
2628
2629 return spec;
2630}
2631
2632static void rbd_spec_free(struct kref *kref)
2633{
2634 struct rbd_spec *spec = container_of(kref, struct rbd_spec, kref);
2635
2636 kfree(spec->pool_name);
2637 kfree(spec->image_id);
2638 kfree(spec->image_name);
2639 kfree(spec->snap_name);
2640 kfree(spec);
2641}
2642
Alex Elderc53d5892012-10-25 23:34:42 -05002643struct rbd_device *rbd_dev_create(struct rbd_client *rbdc,
2644 struct rbd_spec *spec)
2645{
2646 struct rbd_device *rbd_dev;
2647
2648 rbd_dev = kzalloc(sizeof (*rbd_dev), GFP_KERNEL);
2649 if (!rbd_dev)
2650 return NULL;
2651
2652 spin_lock_init(&rbd_dev->lock);
Alex Elder6d292902013-01-14 12:43:31 -06002653 rbd_dev->flags = 0;
Alex Elderc53d5892012-10-25 23:34:42 -05002654 INIT_LIST_HEAD(&rbd_dev->node);
2655 INIT_LIST_HEAD(&rbd_dev->snaps);
2656 init_rwsem(&rbd_dev->header_rwsem);
2657
2658 rbd_dev->spec = spec;
2659 rbd_dev->rbd_client = rbdc;
2660
Alex Elder0903e872012-11-14 12:25:19 -06002661 /* Initialize the layout used for all rbd requests */
2662
2663 rbd_dev->layout.fl_stripe_unit = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
2664 rbd_dev->layout.fl_stripe_count = cpu_to_le32(1);
2665 rbd_dev->layout.fl_object_size = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
2666 rbd_dev->layout.fl_pg_pool = cpu_to_le32((u32) spec->pool_id);
2667
Alex Elderc53d5892012-10-25 23:34:42 -05002668 return rbd_dev;
2669}
2670
2671static void rbd_dev_destroy(struct rbd_device *rbd_dev)
2672{
Alex Elder86b00e02012-10-25 23:34:42 -05002673 rbd_spec_put(rbd_dev->parent_spec);
Alex Elderc53d5892012-10-25 23:34:42 -05002674 kfree(rbd_dev->header_name);
2675 rbd_put_client(rbd_dev->rbd_client);
2676 rbd_spec_put(rbd_dev->spec);
2677 kfree(rbd_dev);
2678}
2679
Alex Elder304f6802012-08-31 17:29:52 -05002680static bool rbd_snap_registered(struct rbd_snap *snap)
2681{
2682 bool ret = snap->dev.type == &rbd_snap_device_type;
2683 bool reg = device_is_registered(&snap->dev);
2684
2685 rbd_assert(!ret ^ reg);
2686
2687 return ret;
2688}
2689
Alex Elder41f38c22012-10-25 23:34:40 -05002690static void rbd_remove_snap_dev(struct rbd_snap *snap)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002691{
2692 list_del(&snap->node);
Alex Elder304f6802012-08-31 17:29:52 -05002693 if (device_is_registered(&snap->dev))
2694 device_unregister(&snap->dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002695}
2696
Alex Elder14e70852012-07-19 09:09:27 -05002697static int rbd_register_snap_dev(struct rbd_snap *snap,
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002698 struct device *parent)
2699{
2700 struct device *dev = &snap->dev;
2701 int ret;
2702
2703 dev->type = &rbd_snap_device_type;
2704 dev->parent = parent;
2705 dev->release = rbd_snap_dev_release;
Alex Elderd4b125e2012-07-03 16:01:19 -05002706 dev_set_name(dev, "%s%s", RBD_SNAP_DEV_NAME_PREFIX, snap->name);
Alex Elder304f6802012-08-31 17:29:52 -05002707 dout("%s: registering device for snapshot %s\n", __func__, snap->name);
2708
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002709 ret = device_register(dev);
2710
2711 return ret;
2712}
2713
Alex Elder4e891e02012-07-10 20:30:10 -05002714static struct rbd_snap *__rbd_add_snap_dev(struct rbd_device *rbd_dev,
Alex Elderc8d18422012-07-10 20:30:11 -05002715 const char *snap_name,
Alex Elder34b13182012-07-13 20:35:12 -05002716 u64 snap_id, u64 snap_size,
2717 u64 snap_features)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002718{
Alex Elder4e891e02012-07-10 20:30:10 -05002719 struct rbd_snap *snap;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002720 int ret;
Alex Elder4e891e02012-07-10 20:30:10 -05002721
2722 snap = kzalloc(sizeof (*snap), GFP_KERNEL);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002723 if (!snap)
Alex Elder4e891e02012-07-10 20:30:10 -05002724 return ERR_PTR(-ENOMEM);
2725
2726 ret = -ENOMEM;
Alex Elderc8d18422012-07-10 20:30:11 -05002727 snap->name = kstrdup(snap_name, GFP_KERNEL);
Alex Elder4e891e02012-07-10 20:30:10 -05002728 if (!snap->name)
2729 goto err;
2730
Alex Elderc8d18422012-07-10 20:30:11 -05002731 snap->id = snap_id;
2732 snap->size = snap_size;
Alex Elder34b13182012-07-13 20:35:12 -05002733 snap->features = snap_features;
Alex Elder4e891e02012-07-10 20:30:10 -05002734
2735 return snap;
2736
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002737err:
2738 kfree(snap->name);
2739 kfree(snap);
Alex Elder4e891e02012-07-10 20:30:10 -05002740
2741 return ERR_PTR(ret);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002742}
2743
Alex Eldercd892122012-07-03 16:01:19 -05002744static char *rbd_dev_v1_snap_info(struct rbd_device *rbd_dev, u32 which,
2745 u64 *snap_size, u64 *snap_features)
2746{
2747 char *snap_name;
2748
2749 rbd_assert(which < rbd_dev->header.snapc->num_snaps);
2750
2751 *snap_size = rbd_dev->header.snap_sizes[which];
2752 *snap_features = 0; /* No features for v1 */
2753
2754 /* Skip over names until we find the one we are looking for */
2755
2756 snap_name = rbd_dev->header.snap_names;
2757 while (which--)
2758 snap_name += strlen(snap_name) + 1;
2759
2760 return snap_name;
2761}
2762
Yehuda Sadehdfc56062010-11-19 14:51:04 -08002763/*
Alex Elder9d475de2012-07-03 16:01:19 -05002764 * Get the size and object order for an image snapshot, or if
2765 * snap_id is CEPH_NOSNAP, gets this information for the base
2766 * image.
2767 */
2768static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
2769 u8 *order, u64 *snap_size)
2770{
2771 __le64 snapid = cpu_to_le64(snap_id);
2772 int ret;
2773 struct {
2774 u8 order;
2775 __le64 size;
2776 } __attribute__ ((packed)) size_buf = { 0 };
2777
Alex Elder36be9a72013-01-19 00:30:28 -06002778 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder9d475de2012-07-03 16:01:19 -05002779 "rbd", "get_size",
2780 (char *) &snapid, sizeof (snapid),
Alex Elder07b23912012-11-09 08:43:16 -06002781 (char *) &size_buf, sizeof (size_buf), NULL);
Alex Elder36be9a72013-01-19 00:30:28 -06002782 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder9d475de2012-07-03 16:01:19 -05002783 if (ret < 0)
2784 return ret;
2785
2786 *order = size_buf.order;
2787 *snap_size = le64_to_cpu(size_buf.size);
2788
2789 dout(" snap_id 0x%016llx order = %u, snap_size = %llu\n",
2790 (unsigned long long) snap_id, (unsigned int) *order,
2791 (unsigned long long) *snap_size);
2792
2793 return 0;
2794}
2795
2796static int rbd_dev_v2_image_size(struct rbd_device *rbd_dev)
2797{
2798 return _rbd_dev_v2_snap_size(rbd_dev, CEPH_NOSNAP,
2799 &rbd_dev->header.obj_order,
2800 &rbd_dev->header.image_size);
2801}
2802
Alex Elder1e130192012-07-03 16:01:19 -05002803static int rbd_dev_v2_object_prefix(struct rbd_device *rbd_dev)
2804{
2805 void *reply_buf;
2806 int ret;
2807 void *p;
2808
2809 reply_buf = kzalloc(RBD_OBJ_PREFIX_LEN_MAX, GFP_KERNEL);
2810 if (!reply_buf)
2811 return -ENOMEM;
2812
Alex Elder36be9a72013-01-19 00:30:28 -06002813 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder1e130192012-07-03 16:01:19 -05002814 "rbd", "get_object_prefix",
2815 NULL, 0,
Alex Elder07b23912012-11-09 08:43:16 -06002816 reply_buf, RBD_OBJ_PREFIX_LEN_MAX, NULL);
Alex Elder36be9a72013-01-19 00:30:28 -06002817 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder1e130192012-07-03 16:01:19 -05002818 if (ret < 0)
2819 goto out;
2820
2821 p = reply_buf;
2822 rbd_dev->header.object_prefix = ceph_extract_encoded_string(&p,
2823 p + RBD_OBJ_PREFIX_LEN_MAX,
2824 NULL, GFP_NOIO);
2825
2826 if (IS_ERR(rbd_dev->header.object_prefix)) {
2827 ret = PTR_ERR(rbd_dev->header.object_prefix);
2828 rbd_dev->header.object_prefix = NULL;
2829 } else {
2830 dout(" object_prefix = %s\n", rbd_dev->header.object_prefix);
2831 }
2832
2833out:
2834 kfree(reply_buf);
2835
2836 return ret;
2837}
2838
Alex Elderb1b54022012-07-03 16:01:19 -05002839static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
2840 u64 *snap_features)
2841{
2842 __le64 snapid = cpu_to_le64(snap_id);
2843 struct {
2844 __le64 features;
2845 __le64 incompat;
2846 } features_buf = { 0 };
Alex Elderd8891402012-10-09 13:50:17 -07002847 u64 incompat;
Alex Elderb1b54022012-07-03 16:01:19 -05002848 int ret;
2849
Alex Elder36be9a72013-01-19 00:30:28 -06002850 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elderb1b54022012-07-03 16:01:19 -05002851 "rbd", "get_features",
2852 (char *) &snapid, sizeof (snapid),
2853 (char *) &features_buf, sizeof (features_buf),
Alex Elder07b23912012-11-09 08:43:16 -06002854 NULL);
Alex Elder36be9a72013-01-19 00:30:28 -06002855 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elderb1b54022012-07-03 16:01:19 -05002856 if (ret < 0)
2857 return ret;
Alex Elderd8891402012-10-09 13:50:17 -07002858
2859 incompat = le64_to_cpu(features_buf.incompat);
2860 if (incompat & ~RBD_FEATURES_ALL)
Alex Elderb8f5c6e2012-11-01 08:39:26 -05002861 return -ENXIO;
Alex Elderd8891402012-10-09 13:50:17 -07002862
Alex Elderb1b54022012-07-03 16:01:19 -05002863 *snap_features = le64_to_cpu(features_buf.features);
2864
2865 dout(" snap_id 0x%016llx features = 0x%016llx incompat = 0x%016llx\n",
2866 (unsigned long long) snap_id,
2867 (unsigned long long) *snap_features,
2868 (unsigned long long) le64_to_cpu(features_buf.incompat));
2869
2870 return 0;
2871}
2872
2873static int rbd_dev_v2_features(struct rbd_device *rbd_dev)
2874{
2875 return _rbd_dev_v2_snap_features(rbd_dev, CEPH_NOSNAP,
2876 &rbd_dev->header.features);
2877}
2878
Alex Elder86b00e02012-10-25 23:34:42 -05002879static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev)
2880{
2881 struct rbd_spec *parent_spec;
2882 size_t size;
2883 void *reply_buf = NULL;
2884 __le64 snapid;
2885 void *p;
2886 void *end;
2887 char *image_id;
2888 u64 overlap;
Alex Elder86b00e02012-10-25 23:34:42 -05002889 int ret;
2890
2891 parent_spec = rbd_spec_alloc();
2892 if (!parent_spec)
2893 return -ENOMEM;
2894
2895 size = sizeof (__le64) + /* pool_id */
2896 sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX + /* image_id */
2897 sizeof (__le64) + /* snap_id */
2898 sizeof (__le64); /* overlap */
2899 reply_buf = kmalloc(size, GFP_KERNEL);
2900 if (!reply_buf) {
2901 ret = -ENOMEM;
2902 goto out_err;
2903 }
2904
2905 snapid = cpu_to_le64(CEPH_NOSNAP);
Alex Elder36be9a72013-01-19 00:30:28 -06002906 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder86b00e02012-10-25 23:34:42 -05002907 "rbd", "get_parent",
2908 (char *) &snapid, sizeof (snapid),
Alex Elder07b23912012-11-09 08:43:16 -06002909 (char *) reply_buf, size, NULL);
Alex Elder36be9a72013-01-19 00:30:28 -06002910 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder86b00e02012-10-25 23:34:42 -05002911 if (ret < 0)
2912 goto out_err;
2913
2914 ret = -ERANGE;
2915 p = reply_buf;
2916 end = (char *) reply_buf + size;
2917 ceph_decode_64_safe(&p, end, parent_spec->pool_id, out_err);
2918 if (parent_spec->pool_id == CEPH_NOPOOL)
2919 goto out; /* No parent? No problem. */
2920
Alex Elder0903e872012-11-14 12:25:19 -06002921 /* The ceph file layout needs to fit pool id in 32 bits */
2922
2923 ret = -EIO;
2924 if (WARN_ON(parent_spec->pool_id > (u64) U32_MAX))
2925 goto out;
2926
Alex Elder979ed482012-11-01 08:39:26 -05002927 image_id = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
Alex Elder86b00e02012-10-25 23:34:42 -05002928 if (IS_ERR(image_id)) {
2929 ret = PTR_ERR(image_id);
2930 goto out_err;
2931 }
2932 parent_spec->image_id = image_id;
2933 ceph_decode_64_safe(&p, end, parent_spec->snap_id, out_err);
2934 ceph_decode_64_safe(&p, end, overlap, out_err);
2935
2936 rbd_dev->parent_overlap = overlap;
2937 rbd_dev->parent_spec = parent_spec;
2938 parent_spec = NULL; /* rbd_dev now owns this */
2939out:
2940 ret = 0;
2941out_err:
2942 kfree(reply_buf);
2943 rbd_spec_put(parent_spec);
2944
2945 return ret;
2946}
2947
Alex Elder9e15b772012-10-30 19:40:33 -05002948static char *rbd_dev_image_name(struct rbd_device *rbd_dev)
2949{
2950 size_t image_id_size;
2951 char *image_id;
2952 void *p;
2953 void *end;
2954 size_t size;
2955 void *reply_buf = NULL;
2956 size_t len = 0;
2957 char *image_name = NULL;
2958 int ret;
2959
2960 rbd_assert(!rbd_dev->spec->image_name);
2961
Alex Elder69e7a022012-11-01 08:39:26 -05002962 len = strlen(rbd_dev->spec->image_id);
2963 image_id_size = sizeof (__le32) + len;
Alex Elder9e15b772012-10-30 19:40:33 -05002964 image_id = kmalloc(image_id_size, GFP_KERNEL);
2965 if (!image_id)
2966 return NULL;
2967
2968 p = image_id;
2969 end = (char *) image_id + image_id_size;
Alex Elder69e7a022012-11-01 08:39:26 -05002970 ceph_encode_string(&p, end, rbd_dev->spec->image_id, (u32) len);
Alex Elder9e15b772012-10-30 19:40:33 -05002971
2972 size = sizeof (__le32) + RBD_IMAGE_NAME_LEN_MAX;
2973 reply_buf = kmalloc(size, GFP_KERNEL);
2974 if (!reply_buf)
2975 goto out;
2976
Alex Elder36be9a72013-01-19 00:30:28 -06002977 ret = rbd_obj_method_sync(rbd_dev, RBD_DIRECTORY,
Alex Elder9e15b772012-10-30 19:40:33 -05002978 "rbd", "dir_get_name",
2979 image_id, image_id_size,
Alex Elder07b23912012-11-09 08:43:16 -06002980 (char *) reply_buf, size, NULL);
Alex Elder9e15b772012-10-30 19:40:33 -05002981 if (ret < 0)
2982 goto out;
2983 p = reply_buf;
2984 end = (char *) reply_buf + size;
2985 image_name = ceph_extract_encoded_string(&p, end, &len, GFP_KERNEL);
2986 if (IS_ERR(image_name))
2987 image_name = NULL;
2988 else
2989 dout("%s: name is %s len is %zd\n", __func__, image_name, len);
2990out:
2991 kfree(reply_buf);
2992 kfree(image_id);
2993
2994 return image_name;
2995}
2996
2997/*
2998 * When a parent image gets probed, we only have the pool, image,
2999 * and snapshot ids but not the names of any of them. This call
3000 * is made later to fill in those names. It has to be done after
3001 * rbd_dev_snaps_update() has completed because some of the
3002 * information (in particular, snapshot name) is not available
3003 * until then.
3004 */
3005static int rbd_dev_probe_update_spec(struct rbd_device *rbd_dev)
3006{
3007 struct ceph_osd_client *osdc;
3008 const char *name;
3009 void *reply_buf = NULL;
3010 int ret;
3011
3012 if (rbd_dev->spec->pool_name)
3013 return 0; /* Already have the names */
3014
3015 /* Look up the pool name */
3016
3017 osdc = &rbd_dev->rbd_client->client->osdc;
3018 name = ceph_pg_pool_name_by_id(osdc->osdmap, rbd_dev->spec->pool_id);
Alex Elder935dc892012-11-01 10:17:15 -05003019 if (!name) {
3020 rbd_warn(rbd_dev, "there is no pool with id %llu",
3021 rbd_dev->spec->pool_id); /* Really a BUG() */
3022 return -EIO;
3023 }
Alex Elder9e15b772012-10-30 19:40:33 -05003024
3025 rbd_dev->spec->pool_name = kstrdup(name, GFP_KERNEL);
3026 if (!rbd_dev->spec->pool_name)
3027 return -ENOMEM;
3028
3029 /* Fetch the image name; tolerate failure here */
3030
3031 name = rbd_dev_image_name(rbd_dev);
Alex Elder69e7a022012-11-01 08:39:26 -05003032 if (name)
Alex Elder9e15b772012-10-30 19:40:33 -05003033 rbd_dev->spec->image_name = (char *) name;
Alex Elder69e7a022012-11-01 08:39:26 -05003034 else
Alex Elder06ecc6c2012-11-01 10:17:15 -05003035 rbd_warn(rbd_dev, "unable to get image name");
Alex Elder9e15b772012-10-30 19:40:33 -05003036
3037 /* Look up the snapshot name. */
3038
3039 name = rbd_snap_name(rbd_dev, rbd_dev->spec->snap_id);
3040 if (!name) {
Alex Elder935dc892012-11-01 10:17:15 -05003041 rbd_warn(rbd_dev, "no snapshot with id %llu",
3042 rbd_dev->spec->snap_id); /* Really a BUG() */
Alex Elder9e15b772012-10-30 19:40:33 -05003043 ret = -EIO;
3044 goto out_err;
3045 }
3046 rbd_dev->spec->snap_name = kstrdup(name, GFP_KERNEL);
3047 if(!rbd_dev->spec->snap_name)
3048 goto out_err;
3049
3050 return 0;
3051out_err:
3052 kfree(reply_buf);
3053 kfree(rbd_dev->spec->pool_name);
3054 rbd_dev->spec->pool_name = NULL;
3055
3056 return ret;
3057}
3058
Alex Elder6e14b1a2012-07-03 16:01:19 -05003059static int rbd_dev_v2_snap_context(struct rbd_device *rbd_dev, u64 *ver)
Alex Elder35d489f2012-07-03 16:01:19 -05003060{
3061 size_t size;
3062 int ret;
3063 void *reply_buf;
3064 void *p;
3065 void *end;
3066 u64 seq;
3067 u32 snap_count;
3068 struct ceph_snap_context *snapc;
3069 u32 i;
3070
3071 /*
3072 * We'll need room for the seq value (maximum snapshot id),
3073 * snapshot count, and array of that many snapshot ids.
3074 * For now we have a fixed upper limit on the number we're
3075 * prepared to receive.
3076 */
3077 size = sizeof (__le64) + sizeof (__le32) +
3078 RBD_MAX_SNAP_COUNT * sizeof (__le64);
3079 reply_buf = kzalloc(size, GFP_KERNEL);
3080 if (!reply_buf)
3081 return -ENOMEM;
3082
Alex Elder36be9a72013-01-19 00:30:28 -06003083 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elder35d489f2012-07-03 16:01:19 -05003084 "rbd", "get_snapcontext",
3085 NULL, 0,
Alex Elder07b23912012-11-09 08:43:16 -06003086 reply_buf, size, ver);
Alex Elder36be9a72013-01-19 00:30:28 -06003087 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder35d489f2012-07-03 16:01:19 -05003088 if (ret < 0)
3089 goto out;
3090
3091 ret = -ERANGE;
3092 p = reply_buf;
3093 end = (char *) reply_buf + size;
3094 ceph_decode_64_safe(&p, end, seq, out);
3095 ceph_decode_32_safe(&p, end, snap_count, out);
3096
3097 /*
3098 * Make sure the reported number of snapshot ids wouldn't go
3099 * beyond the end of our buffer. But before checking that,
3100 * make sure the computed size of the snapshot context we
3101 * allocate is representable in a size_t.
3102 */
3103 if (snap_count > (SIZE_MAX - sizeof (struct ceph_snap_context))
3104 / sizeof (u64)) {
3105 ret = -EINVAL;
3106 goto out;
3107 }
3108 if (!ceph_has_room(&p, end, snap_count * sizeof (__le64)))
3109 goto out;
3110
3111 size = sizeof (struct ceph_snap_context) +
3112 snap_count * sizeof (snapc->snaps[0]);
3113 snapc = kmalloc(size, GFP_KERNEL);
3114 if (!snapc) {
3115 ret = -ENOMEM;
3116 goto out;
3117 }
3118
3119 atomic_set(&snapc->nref, 1);
3120 snapc->seq = seq;
3121 snapc->num_snaps = snap_count;
3122 for (i = 0; i < snap_count; i++)
3123 snapc->snaps[i] = ceph_decode_64(&p);
3124
3125 rbd_dev->header.snapc = snapc;
3126
3127 dout(" snap context seq = %llu, snap_count = %u\n",
3128 (unsigned long long) seq, (unsigned int) snap_count);
3129
3130out:
3131 kfree(reply_buf);
3132
3133 return 0;
3134}
3135
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003136static char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev, u32 which)
3137{
3138 size_t size;
3139 void *reply_buf;
3140 __le64 snap_id;
3141 int ret;
3142 void *p;
3143 void *end;
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003144 char *snap_name;
3145
3146 size = sizeof (__le32) + RBD_MAX_SNAP_NAME_LEN;
3147 reply_buf = kmalloc(size, GFP_KERNEL);
3148 if (!reply_buf)
3149 return ERR_PTR(-ENOMEM);
3150
3151 snap_id = cpu_to_le64(rbd_dev->header.snapc->snaps[which]);
Alex Elder36be9a72013-01-19 00:30:28 -06003152 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003153 "rbd", "get_snapshot_name",
3154 (char *) &snap_id, sizeof (snap_id),
Alex Elder07b23912012-11-09 08:43:16 -06003155 reply_buf, size, NULL);
Alex Elder36be9a72013-01-19 00:30:28 -06003156 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003157 if (ret < 0)
3158 goto out;
3159
3160 p = reply_buf;
3161 end = (char *) reply_buf + size;
Alex Eldere5c35532012-10-25 23:34:41 -05003162 snap_name = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003163 if (IS_ERR(snap_name)) {
3164 ret = PTR_ERR(snap_name);
3165 goto out;
3166 } else {
3167 dout(" snap_id 0x%016llx snap_name = %s\n",
3168 (unsigned long long) le64_to_cpu(snap_id), snap_name);
3169 }
3170 kfree(reply_buf);
3171
3172 return snap_name;
3173out:
3174 kfree(reply_buf);
3175
3176 return ERR_PTR(ret);
3177}
3178
3179static char *rbd_dev_v2_snap_info(struct rbd_device *rbd_dev, u32 which,
3180 u64 *snap_size, u64 *snap_features)
3181{
Alex Eldere0b49862013-01-09 14:44:18 -06003182 u64 snap_id;
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003183 u8 order;
3184 int ret;
3185
3186 snap_id = rbd_dev->header.snapc->snaps[which];
3187 ret = _rbd_dev_v2_snap_size(rbd_dev, snap_id, &order, snap_size);
3188 if (ret)
3189 return ERR_PTR(ret);
3190 ret = _rbd_dev_v2_snap_features(rbd_dev, snap_id, snap_features);
3191 if (ret)
3192 return ERR_PTR(ret);
3193
3194 return rbd_dev_v2_snap_name(rbd_dev, which);
3195}
3196
3197static char *rbd_dev_snap_info(struct rbd_device *rbd_dev, u32 which,
3198 u64 *snap_size, u64 *snap_features)
3199{
3200 if (rbd_dev->image_format == 1)
3201 return rbd_dev_v1_snap_info(rbd_dev, which,
3202 snap_size, snap_features);
3203 if (rbd_dev->image_format == 2)
3204 return rbd_dev_v2_snap_info(rbd_dev, which,
3205 snap_size, snap_features);
3206 return ERR_PTR(-EINVAL);
3207}
3208
Alex Elder117973f2012-08-31 17:29:55 -05003209static int rbd_dev_v2_refresh(struct rbd_device *rbd_dev, u64 *hver)
3210{
3211 int ret;
3212 __u8 obj_order;
3213
3214 down_write(&rbd_dev->header_rwsem);
3215
3216 /* Grab old order first, to see if it changes */
3217
3218 obj_order = rbd_dev->header.obj_order,
3219 ret = rbd_dev_v2_image_size(rbd_dev);
3220 if (ret)
3221 goto out;
3222 if (rbd_dev->header.obj_order != obj_order) {
3223 ret = -EIO;
3224 goto out;
3225 }
3226 rbd_update_mapping_size(rbd_dev);
3227
3228 ret = rbd_dev_v2_snap_context(rbd_dev, hver);
3229 dout("rbd_dev_v2_snap_context returned %d\n", ret);
3230 if (ret)
3231 goto out;
3232 ret = rbd_dev_snaps_update(rbd_dev);
3233 dout("rbd_dev_snaps_update returned %d\n", ret);
3234 if (ret)
3235 goto out;
3236 ret = rbd_dev_snaps_register(rbd_dev);
3237 dout("rbd_dev_snaps_register returned %d\n", ret);
3238out:
3239 up_write(&rbd_dev->header_rwsem);
3240
3241 return ret;
3242}
3243
Alex Elder9d475de2012-07-03 16:01:19 -05003244/*
Alex Elder35938152012-08-02 11:29:46 -05003245 * Scan the rbd device's current snapshot list and compare it to the
3246 * newly-received snapshot context. Remove any existing snapshots
3247 * not present in the new snapshot context. Add a new snapshot for
3248 * any snaphots in the snapshot context not in the current list.
3249 * And verify there are no changes to snapshots we already know
3250 * about.
3251 *
3252 * Assumes the snapshots in the snapshot context are sorted by
3253 * snapshot id, highest id first. (Snapshots in the rbd_dev's list
3254 * are also maintained in that order.)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003255 */
Alex Elder304f6802012-08-31 17:29:52 -05003256static int rbd_dev_snaps_update(struct rbd_device *rbd_dev)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003257{
Alex Elder35938152012-08-02 11:29:46 -05003258 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
3259 const u32 snap_count = snapc->num_snaps;
Alex Elder35938152012-08-02 11:29:46 -05003260 struct list_head *head = &rbd_dev->snaps;
3261 struct list_head *links = head->next;
3262 u32 index = 0;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003263
Alex Elder9fcbb802012-08-23 23:48:49 -05003264 dout("%s: snap count is %u\n", __func__, (unsigned int) snap_count);
Alex Elder35938152012-08-02 11:29:46 -05003265 while (index < snap_count || links != head) {
3266 u64 snap_id;
3267 struct rbd_snap *snap;
Alex Eldercd892122012-07-03 16:01:19 -05003268 char *snap_name;
3269 u64 snap_size = 0;
3270 u64 snap_features = 0;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003271
Alex Elder35938152012-08-02 11:29:46 -05003272 snap_id = index < snap_count ? snapc->snaps[index]
3273 : CEPH_NOSNAP;
3274 snap = links != head ? list_entry(links, struct rbd_snap, node)
3275 : NULL;
Alex Elderaafb2302012-09-06 16:00:54 -05003276 rbd_assert(!snap || snap->id != CEPH_NOSNAP);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003277
Alex Elder35938152012-08-02 11:29:46 -05003278 if (snap_id == CEPH_NOSNAP || (snap && snap->id > snap_id)) {
3279 struct list_head *next = links->next;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003280
Alex Elder6d292902013-01-14 12:43:31 -06003281 /*
3282 * A previously-existing snapshot is not in
3283 * the new snap context.
3284 *
3285 * If the now missing snapshot is the one the
3286 * image is mapped to, clear its exists flag
3287 * so we can avoid sending any more requests
3288 * to it.
3289 */
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003290 if (rbd_dev->spec->snap_id == snap->id)
Alex Elder6d292902013-01-14 12:43:31 -06003291 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
Alex Elder41f38c22012-10-25 23:34:40 -05003292 rbd_remove_snap_dev(snap);
Alex Elder9fcbb802012-08-23 23:48:49 -05003293 dout("%ssnap id %llu has been removed\n",
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003294 rbd_dev->spec->snap_id == snap->id ?
3295 "mapped " : "",
Alex Elder9fcbb802012-08-23 23:48:49 -05003296 (unsigned long long) snap->id);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003297
Alex Elder35938152012-08-02 11:29:46 -05003298 /* Done with this list entry; advance */
3299
3300 links = next;
3301 continue;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003302 }
Alex Elder35938152012-08-02 11:29:46 -05003303
Alex Elderb8b1e2d2012-07-03 16:01:19 -05003304 snap_name = rbd_dev_snap_info(rbd_dev, index,
3305 &snap_size, &snap_features);
Alex Eldercd892122012-07-03 16:01:19 -05003306 if (IS_ERR(snap_name))
3307 return PTR_ERR(snap_name);
3308
Alex Elder9fcbb802012-08-23 23:48:49 -05003309 dout("entry %u: snap_id = %llu\n", (unsigned int) snap_count,
3310 (unsigned long long) snap_id);
Alex Elder35938152012-08-02 11:29:46 -05003311 if (!snap || (snap_id != CEPH_NOSNAP && snap->id < snap_id)) {
3312 struct rbd_snap *new_snap;
3313
3314 /* We haven't seen this snapshot before */
3315
Alex Elderc8d18422012-07-10 20:30:11 -05003316 new_snap = __rbd_add_snap_dev(rbd_dev, snap_name,
Alex Eldercd892122012-07-03 16:01:19 -05003317 snap_id, snap_size, snap_features);
Alex Elder9fcbb802012-08-23 23:48:49 -05003318 if (IS_ERR(new_snap)) {
3319 int err = PTR_ERR(new_snap);
3320
3321 dout(" failed to add dev, error %d\n", err);
3322
3323 return err;
3324 }
Alex Elder35938152012-08-02 11:29:46 -05003325
3326 /* New goes before existing, or at end of list */
3327
Alex Elder9fcbb802012-08-23 23:48:49 -05003328 dout(" added dev%s\n", snap ? "" : " at end\n");
Alex Elder35938152012-08-02 11:29:46 -05003329 if (snap)
3330 list_add_tail(&new_snap->node, &snap->node);
3331 else
Alex Elder523f3252012-08-30 00:16:37 -05003332 list_add_tail(&new_snap->node, head);
Alex Elder35938152012-08-02 11:29:46 -05003333 } else {
3334 /* Already have this one */
3335
Alex Elder9fcbb802012-08-23 23:48:49 -05003336 dout(" already present\n");
3337
Alex Eldercd892122012-07-03 16:01:19 -05003338 rbd_assert(snap->size == snap_size);
Alex Elderaafb2302012-09-06 16:00:54 -05003339 rbd_assert(!strcmp(snap->name, snap_name));
Alex Eldercd892122012-07-03 16:01:19 -05003340 rbd_assert(snap->features == snap_features);
Alex Elder35938152012-08-02 11:29:46 -05003341
3342 /* Done with this list entry; advance */
3343
3344 links = links->next;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003345 }
Alex Elder35938152012-08-02 11:29:46 -05003346
3347 /* Advance to the next entry in the snapshot context */
3348
3349 index++;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003350 }
Alex Elder9fcbb802012-08-23 23:48:49 -05003351 dout("%s: done\n", __func__);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003352
3353 return 0;
3354}
3355
Alex Elder304f6802012-08-31 17:29:52 -05003356/*
3357 * Scan the list of snapshots and register the devices for any that
3358 * have not already been registered.
3359 */
3360static int rbd_dev_snaps_register(struct rbd_device *rbd_dev)
3361{
3362 struct rbd_snap *snap;
3363 int ret = 0;
3364
3365 dout("%s called\n", __func__);
Alex Elder86ff77b2012-08-31 17:29:53 -05003366 if (WARN_ON(!device_is_registered(&rbd_dev->dev)))
3367 return -EIO;
Alex Elder304f6802012-08-31 17:29:52 -05003368
3369 list_for_each_entry(snap, &rbd_dev->snaps, node) {
3370 if (!rbd_snap_registered(snap)) {
3371 ret = rbd_register_snap_dev(snap, &rbd_dev->dev);
3372 if (ret < 0)
3373 break;
3374 }
3375 }
3376 dout("%s: returning %d\n", __func__, ret);
3377
3378 return ret;
3379}
3380
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003381static int rbd_bus_add_dev(struct rbd_device *rbd_dev)
3382{
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003383 struct device *dev;
Alex Eldercd789ab2012-08-30 00:16:38 -05003384 int ret;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003385
3386 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003387
Alex Eldercd789ab2012-08-30 00:16:38 -05003388 dev = &rbd_dev->dev;
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003389 dev->bus = &rbd_bus_type;
3390 dev->type = &rbd_device_type;
3391 dev->parent = &rbd_root_dev;
3392 dev->release = rbd_dev_release;
Alex Elderde71a292012-07-03 16:01:19 -05003393 dev_set_name(dev, "%d", rbd_dev->dev_id);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003394 ret = device_register(dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003395
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003396 mutex_unlock(&ctl_mutex);
Alex Eldercd789ab2012-08-30 00:16:38 -05003397
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003398 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07003399}
3400
Yehuda Sadehdfc56062010-11-19 14:51:04 -08003401static void rbd_bus_del_dev(struct rbd_device *rbd_dev)
3402{
3403 device_unregister(&rbd_dev->dev);
3404}
3405
Alex Eldere2839302012-08-29 17:11:06 -05003406static atomic64_t rbd_dev_id_max = ATOMIC64_INIT(0);
Alex Elder1ddbe942012-01-29 13:57:44 -06003407
3408/*
Alex Elder499afd52012-02-02 08:13:29 -06003409 * Get a unique rbd identifier for the given new rbd_dev, and add
3410 * the rbd_dev to the global list. The minimum rbd id is 1.
Alex Elder1ddbe942012-01-29 13:57:44 -06003411 */
Alex Eldere2839302012-08-29 17:11:06 -05003412static void rbd_dev_id_get(struct rbd_device *rbd_dev)
Alex Elderb7f23c32012-01-29 13:57:43 -06003413{
Alex Eldere2839302012-08-29 17:11:06 -05003414 rbd_dev->dev_id = atomic64_inc_return(&rbd_dev_id_max);
Alex Elder499afd52012-02-02 08:13:29 -06003415
3416 spin_lock(&rbd_dev_list_lock);
3417 list_add_tail(&rbd_dev->node, &rbd_dev_list);
3418 spin_unlock(&rbd_dev_list_lock);
Alex Eldere2839302012-08-29 17:11:06 -05003419 dout("rbd_dev %p given dev id %llu\n", rbd_dev,
3420 (unsigned long long) rbd_dev->dev_id);
Alex Elder1ddbe942012-01-29 13:57:44 -06003421}
Alex Elderb7f23c32012-01-29 13:57:43 -06003422
Alex Elder1ddbe942012-01-29 13:57:44 -06003423/*
Alex Elder499afd52012-02-02 08:13:29 -06003424 * Remove an rbd_dev from the global list, and record that its
3425 * identifier is no longer in use.
Alex Elder1ddbe942012-01-29 13:57:44 -06003426 */
Alex Eldere2839302012-08-29 17:11:06 -05003427static void rbd_dev_id_put(struct rbd_device *rbd_dev)
Alex Elder1ddbe942012-01-29 13:57:44 -06003428{
Alex Elderd184f6b2012-01-29 13:57:44 -06003429 struct list_head *tmp;
Alex Elderde71a292012-07-03 16:01:19 -05003430 int rbd_id = rbd_dev->dev_id;
Alex Elderd184f6b2012-01-29 13:57:44 -06003431 int max_id;
3432
Alex Elderaafb2302012-09-06 16:00:54 -05003433 rbd_assert(rbd_id > 0);
Alex Elder499afd52012-02-02 08:13:29 -06003434
Alex Eldere2839302012-08-29 17:11:06 -05003435 dout("rbd_dev %p released dev id %llu\n", rbd_dev,
3436 (unsigned long long) rbd_dev->dev_id);
Alex Elder499afd52012-02-02 08:13:29 -06003437 spin_lock(&rbd_dev_list_lock);
3438 list_del_init(&rbd_dev->node);
Alex Elderd184f6b2012-01-29 13:57:44 -06003439
3440 /*
3441 * If the id being "put" is not the current maximum, there
3442 * is nothing special we need to do.
3443 */
Alex Eldere2839302012-08-29 17:11:06 -05003444 if (rbd_id != atomic64_read(&rbd_dev_id_max)) {
Alex Elderd184f6b2012-01-29 13:57:44 -06003445 spin_unlock(&rbd_dev_list_lock);
3446 return;
3447 }
3448
3449 /*
3450 * We need to update the current maximum id. Search the
3451 * list to find out what it is. We're more likely to find
3452 * the maximum at the end, so search the list backward.
3453 */
3454 max_id = 0;
3455 list_for_each_prev(tmp, &rbd_dev_list) {
3456 struct rbd_device *rbd_dev;
3457
3458 rbd_dev = list_entry(tmp, struct rbd_device, node);
Alex Elderb213e0b2012-10-10 21:19:13 -07003459 if (rbd_dev->dev_id > max_id)
3460 max_id = rbd_dev->dev_id;
Alex Elderd184f6b2012-01-29 13:57:44 -06003461 }
Alex Elder499afd52012-02-02 08:13:29 -06003462 spin_unlock(&rbd_dev_list_lock);
Alex Elderb7f23c32012-01-29 13:57:43 -06003463
Alex Elder1ddbe942012-01-29 13:57:44 -06003464 /*
Alex Eldere2839302012-08-29 17:11:06 -05003465 * The max id could have been updated by rbd_dev_id_get(), in
Alex Elderd184f6b2012-01-29 13:57:44 -06003466 * which case it now accurately reflects the new maximum.
3467 * Be careful not to overwrite the maximum value in that
3468 * case.
Alex Elder1ddbe942012-01-29 13:57:44 -06003469 */
Alex Eldere2839302012-08-29 17:11:06 -05003470 atomic64_cmpxchg(&rbd_dev_id_max, rbd_id, max_id);
3471 dout(" max dev id has been reset\n");
Alex Elderb7f23c32012-01-29 13:57:43 -06003472}
3473
Alex Eldera725f65e2012-02-02 08:13:30 -06003474/*
Alex Eldere28fff262012-02-02 08:13:30 -06003475 * Skips over white space at *buf, and updates *buf to point to the
3476 * first found non-space character (if any). Returns the length of
Alex Elder593a9e72012-02-07 12:03:37 -06003477 * the token (string of non-white space characters) found. Note
3478 * that *buf must be terminated with '\0'.
Alex Eldere28fff262012-02-02 08:13:30 -06003479 */
3480static inline size_t next_token(const char **buf)
3481{
3482 /*
3483 * These are the characters that produce nonzero for
3484 * isspace() in the "C" and "POSIX" locales.
3485 */
3486 const char *spaces = " \f\n\r\t\v";
3487
3488 *buf += strspn(*buf, spaces); /* Find start of token */
3489
3490 return strcspn(*buf, spaces); /* Return token length */
3491}
3492
3493/*
3494 * Finds the next token in *buf, and if the provided token buffer is
3495 * big enough, copies the found token into it. The result, if
Alex Elder593a9e72012-02-07 12:03:37 -06003496 * copied, is guaranteed to be terminated with '\0'. Note that *buf
3497 * must be terminated with '\0' on entry.
Alex Eldere28fff262012-02-02 08:13:30 -06003498 *
3499 * Returns the length of the token found (not including the '\0').
3500 * Return value will be 0 if no token is found, and it will be >=
3501 * token_size if the token would not fit.
3502 *
Alex Elder593a9e72012-02-07 12:03:37 -06003503 * The *buf pointer will be updated to point beyond the end of the
Alex Eldere28fff262012-02-02 08:13:30 -06003504 * found token. Note that this occurs even if the token buffer is
3505 * too small to hold it.
3506 */
3507static inline size_t copy_token(const char **buf,
3508 char *token,
3509 size_t token_size)
3510{
3511 size_t len;
3512
3513 len = next_token(buf);
3514 if (len < token_size) {
3515 memcpy(token, *buf, len);
3516 *(token + len) = '\0';
3517 }
3518 *buf += len;
3519
3520 return len;
3521}
3522
3523/*
Alex Elderea3352f2012-07-09 21:04:23 -05003524 * Finds the next token in *buf, dynamically allocates a buffer big
3525 * enough to hold a copy of it, and copies the token into the new
3526 * buffer. The copy is guaranteed to be terminated with '\0'. Note
3527 * that a duplicate buffer is created even for a zero-length token.
3528 *
3529 * Returns a pointer to the newly-allocated duplicate, or a null
3530 * pointer if memory for the duplicate was not available. If
3531 * the lenp argument is a non-null pointer, the length of the token
3532 * (not including the '\0') is returned in *lenp.
3533 *
3534 * If successful, the *buf pointer will be updated to point beyond
3535 * the end of the found token.
3536 *
3537 * Note: uses GFP_KERNEL for allocation.
3538 */
3539static inline char *dup_token(const char **buf, size_t *lenp)
3540{
3541 char *dup;
3542 size_t len;
3543
3544 len = next_token(buf);
Alex Elder4caf35f2012-11-01 08:39:27 -05003545 dup = kmemdup(*buf, len + 1, GFP_KERNEL);
Alex Elderea3352f2012-07-09 21:04:23 -05003546 if (!dup)
3547 return NULL;
Alex Elderea3352f2012-07-09 21:04:23 -05003548 *(dup + len) = '\0';
3549 *buf += len;
3550
3551 if (lenp)
3552 *lenp = len;
3553
3554 return dup;
3555}
3556
3557/*
Alex Elder859c31d2012-10-25 23:34:42 -05003558 * Parse the options provided for an "rbd add" (i.e., rbd image
3559 * mapping) request. These arrive via a write to /sys/bus/rbd/add,
3560 * and the data written is passed here via a NUL-terminated buffer.
3561 * Returns 0 if successful or an error code otherwise.
Alex Elderd22f76e2012-07-12 10:46:35 -05003562 *
Alex Elder859c31d2012-10-25 23:34:42 -05003563 * The information extracted from these options is recorded in
3564 * the other parameters which return dynamically-allocated
3565 * structures:
3566 * ceph_opts
3567 * The address of a pointer that will refer to a ceph options
3568 * structure. Caller must release the returned pointer using
3569 * ceph_destroy_options() when it is no longer needed.
3570 * rbd_opts
3571 * Address of an rbd options pointer. Fully initialized by
3572 * this function; caller must release with kfree().
3573 * spec
3574 * Address of an rbd image specification pointer. Fully
3575 * initialized by this function based on parsed options.
3576 * Caller must release with rbd_spec_put().
3577 *
3578 * The options passed take this form:
3579 * <mon_addrs> <options> <pool_name> <image_name> [<snap_id>]
3580 * where:
3581 * <mon_addrs>
3582 * A comma-separated list of one or more monitor addresses.
3583 * A monitor address is an ip address, optionally followed
3584 * by a port number (separated by a colon).
3585 * I.e.: ip1[:port1][,ip2[:port2]...]
3586 * <options>
3587 * A comma-separated list of ceph and/or rbd options.
3588 * <pool_name>
3589 * The name of the rados pool containing the rbd image.
3590 * <image_name>
3591 * The name of the image in that pool to map.
3592 * <snap_id>
3593 * An optional snapshot id. If provided, the mapping will
3594 * present data from the image at the time that snapshot was
3595 * created. The image head is used if no snapshot id is
3596 * provided. Snapshot mappings are always read-only.
Alex Eldera725f65e2012-02-02 08:13:30 -06003597 */
Alex Elder859c31d2012-10-25 23:34:42 -05003598static int rbd_add_parse_args(const char *buf,
Alex Elderdc79b112012-10-25 23:34:41 -05003599 struct ceph_options **ceph_opts,
Alex Elder859c31d2012-10-25 23:34:42 -05003600 struct rbd_options **opts,
3601 struct rbd_spec **rbd_spec)
Alex Eldera725f65e2012-02-02 08:13:30 -06003602{
Alex Elderd22f76e2012-07-12 10:46:35 -05003603 size_t len;
Alex Elder859c31d2012-10-25 23:34:42 -05003604 char *options;
Alex Elder0ddebc02012-10-25 23:34:41 -05003605 const char *mon_addrs;
3606 size_t mon_addrs_size;
Alex Elder859c31d2012-10-25 23:34:42 -05003607 struct rbd_spec *spec = NULL;
Alex Elder4e9afeb2012-10-25 23:34:41 -05003608 struct rbd_options *rbd_opts = NULL;
Alex Elder859c31d2012-10-25 23:34:42 -05003609 struct ceph_options *copts;
Alex Elderdc79b112012-10-25 23:34:41 -05003610 int ret;
Alex Eldere28fff262012-02-02 08:13:30 -06003611
3612 /* The first four tokens are required */
3613
Alex Elder7ef32142012-02-02 08:13:30 -06003614 len = next_token(&buf);
Alex Elder4fb5d672012-11-01 10:17:15 -05003615 if (!len) {
3616 rbd_warn(NULL, "no monitor address(es) provided");
3617 return -EINVAL;
3618 }
Alex Elder0ddebc02012-10-25 23:34:41 -05003619 mon_addrs = buf;
Alex Elderf28e5652012-10-25 23:34:41 -05003620 mon_addrs_size = len + 1;
Alex Elder7ef32142012-02-02 08:13:30 -06003621 buf += len;
Alex Eldera725f65e2012-02-02 08:13:30 -06003622
Alex Elderdc79b112012-10-25 23:34:41 -05003623 ret = -EINVAL;
Alex Elderf28e5652012-10-25 23:34:41 -05003624 options = dup_token(&buf, NULL);
3625 if (!options)
Alex Elderdc79b112012-10-25 23:34:41 -05003626 return -ENOMEM;
Alex Elder4fb5d672012-11-01 10:17:15 -05003627 if (!*options) {
3628 rbd_warn(NULL, "no options provided");
3629 goto out_err;
3630 }
Alex Eldera725f65e2012-02-02 08:13:30 -06003631
Alex Elder859c31d2012-10-25 23:34:42 -05003632 spec = rbd_spec_alloc();
3633 if (!spec)
Alex Elderf28e5652012-10-25 23:34:41 -05003634 goto out_mem;
Alex Elder859c31d2012-10-25 23:34:42 -05003635
3636 spec->pool_name = dup_token(&buf, NULL);
3637 if (!spec->pool_name)
3638 goto out_mem;
Alex Elder4fb5d672012-11-01 10:17:15 -05003639 if (!*spec->pool_name) {
3640 rbd_warn(NULL, "no pool name provided");
3641 goto out_err;
3642 }
Alex Eldere28fff262012-02-02 08:13:30 -06003643
Alex Elder69e7a022012-11-01 08:39:26 -05003644 spec->image_name = dup_token(&buf, NULL);
Alex Elder859c31d2012-10-25 23:34:42 -05003645 if (!spec->image_name)
Alex Elderf28e5652012-10-25 23:34:41 -05003646 goto out_mem;
Alex Elder4fb5d672012-11-01 10:17:15 -05003647 if (!*spec->image_name) {
3648 rbd_warn(NULL, "no image name provided");
3649 goto out_err;
3650 }
Alex Eldere28fff262012-02-02 08:13:30 -06003651
Alex Elderf28e5652012-10-25 23:34:41 -05003652 /*
3653 * Snapshot name is optional; default is to use "-"
3654 * (indicating the head/no snapshot).
3655 */
Alex Elder3feeb8942012-08-31 17:29:52 -05003656 len = next_token(&buf);
Alex Elder820a5f32012-07-09 21:04:24 -05003657 if (!len) {
Alex Elder3feeb8942012-08-31 17:29:52 -05003658 buf = RBD_SNAP_HEAD_NAME; /* No snapshot supplied */
3659 len = sizeof (RBD_SNAP_HEAD_NAME) - 1;
Alex Elderf28e5652012-10-25 23:34:41 -05003660 } else if (len > RBD_MAX_SNAP_NAME_LEN) {
Alex Elderdc79b112012-10-25 23:34:41 -05003661 ret = -ENAMETOOLONG;
Alex Elderf28e5652012-10-25 23:34:41 -05003662 goto out_err;
Alex Elder849b4262012-07-09 21:04:24 -05003663 }
Alex Elder4caf35f2012-11-01 08:39:27 -05003664 spec->snap_name = kmemdup(buf, len + 1, GFP_KERNEL);
Alex Elder859c31d2012-10-25 23:34:42 -05003665 if (!spec->snap_name)
Alex Elderf28e5652012-10-25 23:34:41 -05003666 goto out_mem;
Alex Elder859c31d2012-10-25 23:34:42 -05003667 *(spec->snap_name + len) = '\0';
Alex Eldere5c35532012-10-25 23:34:41 -05003668
Alex Elder0ddebc02012-10-25 23:34:41 -05003669 /* Initialize all rbd options to the defaults */
Alex Eldere28fff262012-02-02 08:13:30 -06003670
Alex Elder4e9afeb2012-10-25 23:34:41 -05003671 rbd_opts = kzalloc(sizeof (*rbd_opts), GFP_KERNEL);
3672 if (!rbd_opts)
3673 goto out_mem;
3674
3675 rbd_opts->read_only = RBD_READ_ONLY_DEFAULT;
Alex Elderd22f76e2012-07-12 10:46:35 -05003676
Alex Elder859c31d2012-10-25 23:34:42 -05003677 copts = ceph_parse_options(options, mon_addrs,
Alex Elder0ddebc02012-10-25 23:34:41 -05003678 mon_addrs + mon_addrs_size - 1,
Alex Elder4e9afeb2012-10-25 23:34:41 -05003679 parse_rbd_opts_token, rbd_opts);
Alex Elder859c31d2012-10-25 23:34:42 -05003680 if (IS_ERR(copts)) {
3681 ret = PTR_ERR(copts);
Alex Elderdc79b112012-10-25 23:34:41 -05003682 goto out_err;
3683 }
Alex Elder859c31d2012-10-25 23:34:42 -05003684 kfree(options);
3685
3686 *ceph_opts = copts;
Alex Elder4e9afeb2012-10-25 23:34:41 -05003687 *opts = rbd_opts;
Alex Elder859c31d2012-10-25 23:34:42 -05003688 *rbd_spec = spec;
Alex Elder0ddebc02012-10-25 23:34:41 -05003689
Alex Elderdc79b112012-10-25 23:34:41 -05003690 return 0;
Alex Elderf28e5652012-10-25 23:34:41 -05003691out_mem:
Alex Elderdc79b112012-10-25 23:34:41 -05003692 ret = -ENOMEM;
Alex Elderd22f76e2012-07-12 10:46:35 -05003693out_err:
Alex Elder859c31d2012-10-25 23:34:42 -05003694 kfree(rbd_opts);
3695 rbd_spec_put(spec);
Alex Elderf28e5652012-10-25 23:34:41 -05003696 kfree(options);
Alex Elderd22f76e2012-07-12 10:46:35 -05003697
Alex Elderdc79b112012-10-25 23:34:41 -05003698 return ret;
Alex Eldera725f65e2012-02-02 08:13:30 -06003699}
3700
Alex Elder589d30e2012-07-10 20:30:11 -05003701/*
3702 * An rbd format 2 image has a unique identifier, distinct from the
3703 * name given to it by the user. Internally, that identifier is
3704 * what's used to specify the names of objects related to the image.
3705 *
3706 * A special "rbd id" object is used to map an rbd image name to its
3707 * id. If that object doesn't exist, then there is no v2 rbd image
3708 * with the supplied name.
3709 *
3710 * This function will record the given rbd_dev's image_id field if
3711 * it can be determined, and in that case will return 0. If any
3712 * errors occur a negative errno will be returned and the rbd_dev's
3713 * image_id field will be unchanged (and should be NULL).
3714 */
3715static int rbd_dev_image_id(struct rbd_device *rbd_dev)
3716{
3717 int ret;
3718 size_t size;
3719 char *object_name;
3720 void *response;
3721 void *p;
3722
3723 /*
Alex Elder2c0d0a12012-10-30 19:40:33 -05003724 * When probing a parent image, the image id is already
3725 * known (and the image name likely is not). There's no
3726 * need to fetch the image id again in this case.
3727 */
3728 if (rbd_dev->spec->image_id)
3729 return 0;
3730
3731 /*
Alex Elder589d30e2012-07-10 20:30:11 -05003732 * First, see if the format 2 image id file exists, and if
3733 * so, get the image's persistent id from it.
3734 */
Alex Elder69e7a022012-11-01 08:39:26 -05003735 size = sizeof (RBD_ID_PREFIX) + strlen(rbd_dev->spec->image_name);
Alex Elder589d30e2012-07-10 20:30:11 -05003736 object_name = kmalloc(size, GFP_NOIO);
3737 if (!object_name)
3738 return -ENOMEM;
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003739 sprintf(object_name, "%s%s", RBD_ID_PREFIX, rbd_dev->spec->image_name);
Alex Elder589d30e2012-07-10 20:30:11 -05003740 dout("rbd id object name is %s\n", object_name);
3741
3742 /* Response will be an encoded string, which includes a length */
3743
3744 size = sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX;
3745 response = kzalloc(size, GFP_NOIO);
3746 if (!response) {
3747 ret = -ENOMEM;
3748 goto out;
3749 }
3750
Alex Elder36be9a72013-01-19 00:30:28 -06003751 ret = rbd_obj_method_sync(rbd_dev, object_name,
Alex Elder589d30e2012-07-10 20:30:11 -05003752 "rbd", "get_id",
3753 NULL, 0,
Alex Elder07b23912012-11-09 08:43:16 -06003754 response, RBD_IMAGE_ID_LEN_MAX, NULL);
Alex Elder36be9a72013-01-19 00:30:28 -06003755 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
Alex Elder589d30e2012-07-10 20:30:11 -05003756 if (ret < 0)
3757 goto out;
3758
3759 p = response;
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003760 rbd_dev->spec->image_id = ceph_extract_encoded_string(&p,
Alex Elder589d30e2012-07-10 20:30:11 -05003761 p + RBD_IMAGE_ID_LEN_MAX,
Alex Elder979ed482012-11-01 08:39:26 -05003762 NULL, GFP_NOIO);
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003763 if (IS_ERR(rbd_dev->spec->image_id)) {
3764 ret = PTR_ERR(rbd_dev->spec->image_id);
3765 rbd_dev->spec->image_id = NULL;
Alex Elder589d30e2012-07-10 20:30:11 -05003766 } else {
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003767 dout("image_id is %s\n", rbd_dev->spec->image_id);
Alex Elder589d30e2012-07-10 20:30:11 -05003768 }
3769out:
3770 kfree(response);
3771 kfree(object_name);
3772
3773 return ret;
3774}
3775
Alex Eldera30b71b2012-07-10 20:30:11 -05003776static int rbd_dev_v1_probe(struct rbd_device *rbd_dev)
3777{
3778 int ret;
3779 size_t size;
3780
3781 /* Version 1 images have no id; empty string is used */
3782
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003783 rbd_dev->spec->image_id = kstrdup("", GFP_KERNEL);
3784 if (!rbd_dev->spec->image_id)
Alex Eldera30b71b2012-07-10 20:30:11 -05003785 return -ENOMEM;
Alex Eldera30b71b2012-07-10 20:30:11 -05003786
3787 /* Record the header object name for this rbd image. */
3788
Alex Elder69e7a022012-11-01 08:39:26 -05003789 size = strlen(rbd_dev->spec->image_name) + sizeof (RBD_SUFFIX);
Alex Eldera30b71b2012-07-10 20:30:11 -05003790 rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
3791 if (!rbd_dev->header_name) {
3792 ret = -ENOMEM;
3793 goto out_err;
3794 }
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003795 sprintf(rbd_dev->header_name, "%s%s",
3796 rbd_dev->spec->image_name, RBD_SUFFIX);
Alex Eldera30b71b2012-07-10 20:30:11 -05003797
3798 /* Populate rbd image metadata */
3799
3800 ret = rbd_read_header(rbd_dev, &rbd_dev->header);
3801 if (ret < 0)
3802 goto out_err;
Alex Elder86b00e02012-10-25 23:34:42 -05003803
3804 /* Version 1 images have no parent (no layering) */
3805
3806 rbd_dev->parent_spec = NULL;
3807 rbd_dev->parent_overlap = 0;
3808
Alex Eldera30b71b2012-07-10 20:30:11 -05003809 rbd_dev->image_format = 1;
3810
3811 dout("discovered version 1 image, header name is %s\n",
3812 rbd_dev->header_name);
3813
3814 return 0;
3815
3816out_err:
3817 kfree(rbd_dev->header_name);
3818 rbd_dev->header_name = NULL;
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003819 kfree(rbd_dev->spec->image_id);
3820 rbd_dev->spec->image_id = NULL;
Alex Eldera30b71b2012-07-10 20:30:11 -05003821
3822 return ret;
3823}
3824
3825static int rbd_dev_v2_probe(struct rbd_device *rbd_dev)
3826{
3827 size_t size;
Alex Elder9d475de2012-07-03 16:01:19 -05003828 int ret;
Alex Elder6e14b1a2012-07-03 16:01:19 -05003829 u64 ver = 0;
Alex Eldera30b71b2012-07-10 20:30:11 -05003830
3831 /*
3832 * Image id was filled in by the caller. Record the header
3833 * object name for this rbd image.
3834 */
Alex Elder979ed482012-11-01 08:39:26 -05003835 size = sizeof (RBD_HEADER_PREFIX) + strlen(rbd_dev->spec->image_id);
Alex Eldera30b71b2012-07-10 20:30:11 -05003836 rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
3837 if (!rbd_dev->header_name)
3838 return -ENOMEM;
3839 sprintf(rbd_dev->header_name, "%s%s",
Alex Elder0d7dbfc2012-10-25 23:34:41 -05003840 RBD_HEADER_PREFIX, rbd_dev->spec->image_id);
Alex Elder9d475de2012-07-03 16:01:19 -05003841
3842 /* Get the size and object order for the image */
3843
3844 ret = rbd_dev_v2_image_size(rbd_dev);
3845 if (ret < 0)
3846 goto out_err;
Alex Elder1e130192012-07-03 16:01:19 -05003847
3848 /* Get the object prefix (a.k.a. block_name) for the image */
3849
3850 ret = rbd_dev_v2_object_prefix(rbd_dev);
3851 if (ret < 0)
3852 goto out_err;
Alex Elderb1b54022012-07-03 16:01:19 -05003853
Alex Elderd8891402012-10-09 13:50:17 -07003854 /* Get the and check features for the image */
Alex Elderb1b54022012-07-03 16:01:19 -05003855
3856 ret = rbd_dev_v2_features(rbd_dev);
3857 if (ret < 0)
3858 goto out_err;
Alex Elder35d489f2012-07-03 16:01:19 -05003859
Alex Elder86b00e02012-10-25 23:34:42 -05003860 /* If the image supports layering, get the parent info */
3861
3862 if (rbd_dev->header.features & RBD_FEATURE_LAYERING) {
3863 ret = rbd_dev_v2_parent_info(rbd_dev);
3864 if (ret < 0)
3865 goto out_err;
3866 }
3867
Alex Elder6e14b1a2012-07-03 16:01:19 -05003868 /* crypto and compression type aren't (yet) supported for v2 images */
Alex Elder35d489f2012-07-03 16:01:19 -05003869
Alex Elder6e14b1a2012-07-03 16:01:19 -05003870 rbd_dev->header.crypt_type = 0;
3871 rbd_dev->header.comp_type = 0;
3872
3873 /* Get the snapshot context, plus the header version */
3874
3875 ret = rbd_dev_v2_snap_context(rbd_dev, &ver);
Alex Elder35d489f2012-07-03 16:01:19 -05003876 if (ret)
3877 goto out_err;
Alex Elder6e14b1a2012-07-03 16:01:19 -05003878 rbd_dev->header.obj_version = ver;
3879
Alex Eldera30b71b2012-07-10 20:30:11 -05003880 rbd_dev->image_format = 2;
3881
3882 dout("discovered version 2 image, header name is %s\n",
3883 rbd_dev->header_name);
3884
Alex Elder35152972012-08-31 17:29:55 -05003885 return 0;
Alex Elder9d475de2012-07-03 16:01:19 -05003886out_err:
Alex Elder86b00e02012-10-25 23:34:42 -05003887 rbd_dev->parent_overlap = 0;
3888 rbd_spec_put(rbd_dev->parent_spec);
3889 rbd_dev->parent_spec = NULL;
Alex Elder9d475de2012-07-03 16:01:19 -05003890 kfree(rbd_dev->header_name);
3891 rbd_dev->header_name = NULL;
Alex Elder1e130192012-07-03 16:01:19 -05003892 kfree(rbd_dev->header.object_prefix);
3893 rbd_dev->header.object_prefix = NULL;
Alex Elder9d475de2012-07-03 16:01:19 -05003894
3895 return ret;
Alex Eldera30b71b2012-07-10 20:30:11 -05003896}
3897
Alex Elder83a06262012-10-30 15:47:17 -05003898static int rbd_dev_probe_finish(struct rbd_device *rbd_dev)
3899{
3900 int ret;
3901
3902 /* no need to lock here, as rbd_dev is not registered yet */
3903 ret = rbd_dev_snaps_update(rbd_dev);
3904 if (ret)
3905 return ret;
3906
Alex Elder9e15b772012-10-30 19:40:33 -05003907 ret = rbd_dev_probe_update_spec(rbd_dev);
3908 if (ret)
3909 goto err_out_snaps;
3910
Alex Elder83a06262012-10-30 15:47:17 -05003911 ret = rbd_dev_set_mapping(rbd_dev);
3912 if (ret)
3913 goto err_out_snaps;
3914
3915 /* generate unique id: find highest unique id, add one */
3916 rbd_dev_id_get(rbd_dev);
3917
3918 /* Fill in the device name, now that we have its id. */
3919 BUILD_BUG_ON(DEV_NAME_LEN
3920 < sizeof (RBD_DRV_NAME) + MAX_INT_FORMAT_WIDTH);
3921 sprintf(rbd_dev->name, "%s%d", RBD_DRV_NAME, rbd_dev->dev_id);
3922
3923 /* Get our block major device number. */
3924
3925 ret = register_blkdev(0, rbd_dev->name);
3926 if (ret < 0)
3927 goto err_out_id;
3928 rbd_dev->major = ret;
3929
3930 /* Set up the blkdev mapping. */
3931
3932 ret = rbd_init_disk(rbd_dev);
3933 if (ret)
3934 goto err_out_blkdev;
3935
3936 ret = rbd_bus_add_dev(rbd_dev);
3937 if (ret)
3938 goto err_out_disk;
3939
3940 /*
3941 * At this point cleanup in the event of an error is the job
3942 * of the sysfs code (initiated by rbd_bus_del_dev()).
3943 */
3944 down_write(&rbd_dev->header_rwsem);
3945 ret = rbd_dev_snaps_register(rbd_dev);
3946 up_write(&rbd_dev->header_rwsem);
3947 if (ret)
3948 goto err_out_bus;
3949
Alex Elder9969ebc2013-01-18 12:31:10 -06003950 ret = rbd_dev_header_watch_sync(rbd_dev, 1);
Alex Elder83a06262012-10-30 15:47:17 -05003951 if (ret)
3952 goto err_out_bus;
3953
3954 /* Everything's ready. Announce the disk to the world. */
3955
3956 add_disk(rbd_dev->disk);
3957
3958 pr_info("%s: added with size 0x%llx\n", rbd_dev->disk->disk_name,
3959 (unsigned long long) rbd_dev->mapping.size);
3960
3961 return ret;
3962err_out_bus:
3963 /* this will also clean up rest of rbd_dev stuff */
3964
3965 rbd_bus_del_dev(rbd_dev);
3966
3967 return ret;
3968err_out_disk:
3969 rbd_free_disk(rbd_dev);
3970err_out_blkdev:
3971 unregister_blkdev(rbd_dev->major, rbd_dev->name);
3972err_out_id:
3973 rbd_dev_id_put(rbd_dev);
3974err_out_snaps:
3975 rbd_remove_all_snaps(rbd_dev);
3976
3977 return ret;
3978}
3979
Alex Eldera30b71b2012-07-10 20:30:11 -05003980/*
3981 * Probe for the existence of the header object for the given rbd
3982 * device. For format 2 images this includes determining the image
3983 * id.
3984 */
3985static int rbd_dev_probe(struct rbd_device *rbd_dev)
3986{
3987 int ret;
3988
3989 /*
3990 * Get the id from the image id object. If it's not a
3991 * format 2 image, we'll get ENOENT back, and we'll assume
3992 * it's a format 1 image.
3993 */
3994 ret = rbd_dev_image_id(rbd_dev);
3995 if (ret)
3996 ret = rbd_dev_v1_probe(rbd_dev);
3997 else
3998 ret = rbd_dev_v2_probe(rbd_dev);
Alex Elder83a06262012-10-30 15:47:17 -05003999 if (ret) {
Alex Eldera30b71b2012-07-10 20:30:11 -05004000 dout("probe failed, returning %d\n", ret);
4001
Alex Elder83a06262012-10-30 15:47:17 -05004002 return ret;
4003 }
4004
4005 ret = rbd_dev_probe_finish(rbd_dev);
4006 if (ret)
4007 rbd_header_free(&rbd_dev->header);
4008
Alex Eldera30b71b2012-07-10 20:30:11 -05004009 return ret;
4010}
4011
Yehuda Sadeh59c2be12011-03-21 15:10:11 -07004012static ssize_t rbd_add(struct bus_type *bus,
4013 const char *buf,
4014 size_t count)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004015{
Alex Eldercb8627c2012-07-09 21:04:23 -05004016 struct rbd_device *rbd_dev = NULL;
Alex Elderdc79b112012-10-25 23:34:41 -05004017 struct ceph_options *ceph_opts = NULL;
Alex Elder4e9afeb2012-10-25 23:34:41 -05004018 struct rbd_options *rbd_opts = NULL;
Alex Elder859c31d2012-10-25 23:34:42 -05004019 struct rbd_spec *spec = NULL;
Alex Elder9d3997f2012-10-25 23:34:42 -05004020 struct rbd_client *rbdc;
Alex Elder27cc2592012-02-02 08:13:30 -06004021 struct ceph_osd_client *osdc;
4022 int rc = -ENOMEM;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004023
4024 if (!try_module_get(THIS_MODULE))
4025 return -ENODEV;
4026
Alex Eldera725f65e2012-02-02 08:13:30 -06004027 /* parse add command */
Alex Elder859c31d2012-10-25 23:34:42 -05004028 rc = rbd_add_parse_args(buf, &ceph_opts, &rbd_opts, &spec);
Alex Elderdc79b112012-10-25 23:34:41 -05004029 if (rc < 0)
Alex Elderbd4ba652012-10-25 23:34:42 -05004030 goto err_out_module;
Alex Eldera725f65e2012-02-02 08:13:30 -06004031
Alex Elder9d3997f2012-10-25 23:34:42 -05004032 rbdc = rbd_get_client(ceph_opts);
4033 if (IS_ERR(rbdc)) {
4034 rc = PTR_ERR(rbdc);
Alex Elder0ddebc02012-10-25 23:34:41 -05004035 goto err_out_args;
Alex Elder9d3997f2012-10-25 23:34:42 -05004036 }
Alex Elderc53d5892012-10-25 23:34:42 -05004037 ceph_opts = NULL; /* rbd_dev client now owns this */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004038
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004039 /* pick the pool */
Alex Elder9d3997f2012-10-25 23:34:42 -05004040 osdc = &rbdc->client->osdc;
Alex Elder859c31d2012-10-25 23:34:42 -05004041 rc = ceph_pg_poolid_by_name(osdc->osdmap, spec->pool_name);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004042 if (rc < 0)
4043 goto err_out_client;
Alex Elder859c31d2012-10-25 23:34:42 -05004044 spec->pool_id = (u64) rc;
4045
Alex Elder0903e872012-11-14 12:25:19 -06004046 /* The ceph file layout needs to fit pool id in 32 bits */
4047
4048 if (WARN_ON(spec->pool_id > (u64) U32_MAX)) {
4049 rc = -EIO;
4050 goto err_out_client;
4051 }
4052
Alex Elderc53d5892012-10-25 23:34:42 -05004053 rbd_dev = rbd_dev_create(rbdc, spec);
Alex Elderbd4ba652012-10-25 23:34:42 -05004054 if (!rbd_dev)
4055 goto err_out_client;
Alex Elderc53d5892012-10-25 23:34:42 -05004056 rbdc = NULL; /* rbd_dev now owns this */
4057 spec = NULL; /* rbd_dev now owns this */
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004058
Alex Elderbd4ba652012-10-25 23:34:42 -05004059 rbd_dev->mapping.read_only = rbd_opts->read_only;
Alex Elderc53d5892012-10-25 23:34:42 -05004060 kfree(rbd_opts);
4061 rbd_opts = NULL; /* done with this */
Alex Elderbd4ba652012-10-25 23:34:42 -05004062
Alex Eldera30b71b2012-07-10 20:30:11 -05004063 rc = rbd_dev_probe(rbd_dev);
4064 if (rc < 0)
Alex Elderc53d5892012-10-25 23:34:42 -05004065 goto err_out_rbd_dev;
Alex Elder05fd6f62012-08-29 17:11:07 -05004066
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004067 return count;
Alex Elderc53d5892012-10-25 23:34:42 -05004068err_out_rbd_dev:
4069 rbd_dev_destroy(rbd_dev);
Alex Elderbd4ba652012-10-25 23:34:42 -05004070err_out_client:
Alex Elder9d3997f2012-10-25 23:34:42 -05004071 rbd_put_client(rbdc);
Alex Elder0ddebc02012-10-25 23:34:41 -05004072err_out_args:
Alex Elder78cea762012-10-25 23:34:41 -05004073 if (ceph_opts)
4074 ceph_destroy_options(ceph_opts);
Alex Elder4e9afeb2012-10-25 23:34:41 -05004075 kfree(rbd_opts);
Alex Elder859c31d2012-10-25 23:34:42 -05004076 rbd_spec_put(spec);
Alex Elderbd4ba652012-10-25 23:34:42 -05004077err_out_module:
4078 module_put(THIS_MODULE);
Alex Elder27cc2592012-02-02 08:13:30 -06004079
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004080 dout("Error adding device %s\n", buf);
Alex Elder27cc2592012-02-02 08:13:30 -06004081
4082 return (ssize_t) rc;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004083}
4084
Alex Elderde71a292012-07-03 16:01:19 -05004085static struct rbd_device *__rbd_get_dev(unsigned long dev_id)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004086{
4087 struct list_head *tmp;
4088 struct rbd_device *rbd_dev;
4089
Alex Eldere124a822012-01-29 13:57:44 -06004090 spin_lock(&rbd_dev_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004091 list_for_each(tmp, &rbd_dev_list) {
4092 rbd_dev = list_entry(tmp, struct rbd_device, node);
Alex Elderde71a292012-07-03 16:01:19 -05004093 if (rbd_dev->dev_id == dev_id) {
Alex Eldere124a822012-01-29 13:57:44 -06004094 spin_unlock(&rbd_dev_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004095 return rbd_dev;
Alex Eldere124a822012-01-29 13:57:44 -06004096 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004097 }
Alex Eldere124a822012-01-29 13:57:44 -06004098 spin_unlock(&rbd_dev_list_lock);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004099 return NULL;
4100}
4101
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004102static void rbd_dev_release(struct device *dev)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004103{
Alex Elder593a9e72012-02-07 12:03:37 -06004104 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004105
Yehuda Sadeh59c2be12011-03-21 15:10:11 -07004106 if (rbd_dev->watch_event)
Alex Elder9969ebc2013-01-18 12:31:10 -06004107 rbd_dev_header_watch_sync(rbd_dev, 0);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004108
4109 /* clean up and free blkdev */
4110 rbd_free_disk(rbd_dev);
4111 unregister_blkdev(rbd_dev->major, rbd_dev->name);
Alex Elder32eec682012-02-08 16:11:14 -06004112
Alex Elder2ac4e752012-07-10 20:30:10 -05004113 /* release allocated disk header fields */
4114 rbd_header_free(&rbd_dev->header);
4115
Alex Elder32eec682012-02-08 16:11:14 -06004116 /* done with the id, and with the rbd_dev */
Alex Eldere2839302012-08-29 17:11:06 -05004117 rbd_dev_id_put(rbd_dev);
Alex Elderc53d5892012-10-25 23:34:42 -05004118 rbd_assert(rbd_dev->rbd_client != NULL);
4119 rbd_dev_destroy(rbd_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004120
4121 /* release module ref */
4122 module_put(THIS_MODULE);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004123}
4124
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004125static ssize_t rbd_remove(struct bus_type *bus,
4126 const char *buf,
4127 size_t count)
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004128{
4129 struct rbd_device *rbd_dev = NULL;
4130 int target_id, rc;
4131 unsigned long ul;
4132 int ret = count;
4133
4134 rc = strict_strtoul(buf, 10, &ul);
4135 if (rc)
4136 return rc;
4137
4138 /* convert to int; abort if we lost anything in the conversion */
4139 target_id = (int) ul;
4140 if (target_id != ul)
4141 return -EINVAL;
4142
4143 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
4144
4145 rbd_dev = __rbd_get_dev(target_id);
4146 if (!rbd_dev) {
4147 ret = -ENOENT;
4148 goto done;
4149 }
4150
Alex Eldera14ea262013-02-05 13:23:12 -06004151 spin_lock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -06004152 if (rbd_dev->open_count)
Alex Elder42382b72012-11-16 09:29:16 -06004153 ret = -EBUSY;
Alex Elderb82d1672013-01-14 12:43:31 -06004154 else
4155 set_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags);
Alex Eldera14ea262013-02-05 13:23:12 -06004156 spin_unlock_irq(&rbd_dev->lock);
Alex Elderb82d1672013-01-14 12:43:31 -06004157 if (ret < 0)
Alex Elder42382b72012-11-16 09:29:16 -06004158 goto done;
Alex Elder42382b72012-11-16 09:29:16 -06004159
Alex Elder41f38c22012-10-25 23:34:40 -05004160 rbd_remove_all_snaps(rbd_dev);
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004161 rbd_bus_del_dev(rbd_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004162
4163done:
4164 mutex_unlock(&ctl_mutex);
Alex Elderaafb2302012-09-06 16:00:54 -05004165
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004166 return ret;
4167}
4168
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004169/*
4170 * create control files in sysfs
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004171 * /sys/bus/rbd/...
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004172 */
4173static int rbd_sysfs_init(void)
4174{
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004175 int ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004176
Alex Elderfed4c142012-02-07 12:03:36 -06004177 ret = device_register(&rbd_root_dev);
Alex Elder21079782012-01-24 10:08:36 -06004178 if (ret < 0)
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004179 return ret;
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004180
Alex Elderfed4c142012-02-07 12:03:36 -06004181 ret = bus_register(&rbd_bus_type);
4182 if (ret < 0)
4183 device_unregister(&rbd_root_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004184
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004185 return ret;
4186}
4187
4188static void rbd_sysfs_cleanup(void)
4189{
Yehuda Sadehdfc56062010-11-19 14:51:04 -08004190 bus_unregister(&rbd_bus_type);
Alex Elderfed4c142012-02-07 12:03:36 -06004191 device_unregister(&rbd_root_dev);
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004192}
4193
4194int __init rbd_init(void)
4195{
4196 int rc;
4197
Alex Elder1e32d342013-01-30 11:13:33 -06004198 if (!libceph_compatible(NULL)) {
4199 rbd_warn(NULL, "libceph incompatibility (quitting)");
4200
4201 return -EINVAL;
4202 }
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004203 rc = rbd_sysfs_init();
4204 if (rc)
4205 return rc;
Alex Elderf0f8cef2012-01-29 13:57:44 -06004206 pr_info("loaded " RBD_DRV_NAME_LONG "\n");
Yehuda Sadeh602adf42010-08-12 16:11:25 -07004207 return 0;
4208}
4209
4210void __exit rbd_exit(void)
4211{
4212 rbd_sysfs_cleanup();
4213}
4214
4215module_init(rbd_init);
4216module_exit(rbd_exit);
4217
4218MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
4219MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
4220MODULE_DESCRIPTION("rados block device");
4221
4222/* following authorship retained from original osdblk.c */
4223MODULE_AUTHOR("Jeff Garzik <jeff@garzik.org>");
4224
4225MODULE_LICENSE("GPL");