rbd.c 106.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
   rbd.c -- Export ceph rados objects as a Linux block device


   based on drivers/block/osdblk.c:

   Copyright 2009 Red Hat, Inc.

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; see the file COPYING.  If not, write to
   the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.



24
   For usage instructions, please refer to:
25

26
                 Documentation/ABI/testing/sysfs-bus-rbd
27 28 29 30 31 32 33

 */

#include <linux/ceph/libceph.h>
#include <linux/ceph/osd_client.h>
#include <linux/ceph/mon_client.h>
#include <linux/ceph/decode.h>
34
#include <linux/parser.h>
35 36 37 38 39 40 41 42 43

#include <linux/kernel.h>
#include <linux/device.h>
#include <linux/module.h>
#include <linux/fs.h>
#include <linux/blkdev.h>

#include "rbd_types.h"

A
Alex Elder 已提交
44 45
#define RBD_DEBUG	/* Activate rbd_assert() calls */

A
Alex Elder 已提交
46 47 48 49 50 51 52 53 54
/*
 * The basic unit of block I/O is a sector.  It is interpreted in a
 * number of contexts in Linux (blk, bio, genhd), but the default is
 * universally 512 bytes.  These symbols are just slightly more
 * meaningful than the bare numbers they represent.
 */
#define	SECTOR_SHIFT	9
#define	SECTOR_SIZE	(1ULL << SECTOR_SHIFT)

55
/* It might be useful to have these defined elsewhere */
56

57 58 59 60
#define	U8_MAX	((u8)	(~0U))
#define	U16_MAX	((u16)	(~0U))
#define	U32_MAX	((u32)	(~0U))
#define	U64_MAX	((u64)	(~0ULL))
61

A
Alex Elder 已提交
62 63
#define RBD_DRV_NAME "rbd"
#define RBD_DRV_NAME_LONG "rbd (rados block device)"
64 65 66

#define RBD_MINORS_PER_MAJOR	256		/* max minors per blkdev */

67 68 69 70
#define RBD_SNAP_DEV_NAME_PREFIX	"snap_"
#define RBD_MAX_SNAP_NAME_LEN	\
			(NAME_MAX - (sizeof (RBD_SNAP_DEV_NAME_PREFIX) - 1))

71
#define RBD_MAX_SNAP_COUNT	510	/* allows max snapc to fit in 4KB */
72 73 74

#define RBD_SNAP_HEAD_NAME	"-"

75 76
/* This allows a single page to hold an image name sent by OSD */
#define RBD_IMAGE_NAME_LEN_MAX	(PAGE_SIZE - sizeof (__le32) - 1)
77
#define RBD_IMAGE_ID_LEN_MAX	64
78

79
#define RBD_OBJ_PREFIX_LEN_MAX	64
A
Alex Elder 已提交
80

A
Alex Elder 已提交
81 82 83 84 85 86 87 88
/* Feature bits */

#define RBD_FEATURE_LAYERING      1

/* Features supported by this (client software) implementation. */

#define RBD_FEATURES_ALL          (0)

A
Alex Elder 已提交
89 90 91 92 93 94
/*
 * An RBD device name will be "rbd#", where the "rbd" comes from
 * RBD_DRV_NAME above, and # is a unique integer identifier.
 * MAX_INT_FORMAT_WIDTH is used in ensuring DEV_NAME_LEN is big
 * enough to hold all possible device names.
 */
95
#define DEV_NAME_LEN		32
A
Alex Elder 已提交
96
#define MAX_INT_FORMAT_WIDTH	((5 * sizeof (int)) / 2 + 1)
97 98 99 100 101

/*
 * block device image metadata (in-memory version)
 */
struct rbd_image_header {
A
Alex Elder 已提交
102
	/* These four fields never change for a given rbd image */
103
	char *object_prefix;
A
Alex Elder 已提交
104
	u64 features;
105 106 107 108
	__u8 obj_order;
	__u8 crypt_type;
	__u8 comp_type;

A
Alex Elder 已提交
109 110 111
	/* The remaining fields need to be updated occasionally */
	u64 image_size;
	struct ceph_snap_context *snapc;
112 113
	char *snap_names;
	u64 *snap_sizes;
114 115 116 117

	u64 obj_version;
};

118 119 120 121
/*
 * An rbd image specification.
 *
 * The tuple (pool_id, image_id, snap_id) is sufficient to uniquely
A
Alex Elder 已提交
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
 * identify an image.  Each rbd_dev structure includes a pointer to
 * an rbd_spec structure that encapsulates this identity.
 *
 * Each of the id's in an rbd_spec has an associated name.  For a
 * user-mapped image, the names are supplied and the id's associated
 * with them are looked up.  For a layered image, a parent image is
 * defined by the tuple, and the names are looked up.
 *
 * An rbd_dev structure contains a parent_spec pointer which is
 * non-null if the image it represents is a child in a layered
 * image.  This pointer will refer to the rbd_spec structure used
 * by the parent rbd_dev for its own identity (i.e., the structure
 * is shared between the parent and child).
 *
 * Since these structures are populated once, during the discovery
 * phase of image construction, they are effectively immutable so
 * we make no effort to synchronize access to them.
 *
 * Note that code herein does not assume the image name is known (it
 * could be a null pointer).
142 143 144 145 146 147 148 149 150 151 152 153 154 155
 */
struct rbd_spec {
	u64		pool_id;
	char		*pool_name;

	char		*image_id;
	char		*image_name;

	u64		snap_id;
	char		*snap_name;

	struct kref	kref;
};

156
/*
A
Alex Elder 已提交
157
 * an instance of the client.  multiple devices may share an rbd client.
158 159 160 161 162 163 164
 */
struct rbd_client {
	struct ceph_client	*client;
	struct kref		kref;
	struct list_head	node;
};

A
Alex Elder 已提交
165 166 167 168 169 170 171 172
struct rbd_img_request;
typedef void (*rbd_img_callback_t)(struct rbd_img_request *);

#define	BAD_WHICH	U32_MAX		/* Good which or bad which, which? */

struct rbd_obj_request;
typedef void (*rbd_obj_callback_t)(struct rbd_obj_request *);

173 174 175
enum obj_request_type {
	OBJ_REQUEST_NODATA, OBJ_REQUEST_BIO, OBJ_REQUEST_PAGES
};
A
Alex Elder 已提交
176 177 178 179 180 181 182 183 184 185 186

struct rbd_obj_request {
	const char		*object_name;
	u64			offset;		/* object start byte */
	u64			length;		/* bytes from offset */

	struct rbd_img_request	*img_request;
	struct list_head	links;		/* img_request->obj_requests */
	u32			which;		/* posn image request list */

	enum obj_request_type	type;
187 188 189 190 191 192 193
	union {
		struct bio	*bio_list;
		struct {
			struct page	**pages;
			u32		page_count;
		};
	};
A
Alex Elder 已提交
194 195 196 197 198

	struct ceph_osd_request	*osd_req;

	u64			xferred;	/* bytes transferred */
	u64			version;
199
	int			result;
A
Alex Elder 已提交
200 201 202
	atomic_t		done;

	rbd_obj_callback_t	callback;
203
	struct completion	completion;
A
Alex Elder 已提交
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

	struct kref		kref;
};

struct rbd_img_request {
	struct request		*rq;
	struct rbd_device	*rbd_dev;
	u64			offset;	/* starting image byte offset */
	u64			length;	/* byte count from offset */
	bool			write_request;	/* false for read */
	union {
		struct ceph_snap_context *snapc;	/* for writes */
		u64		snap_id;		/* for reads */
	};
	spinlock_t		completion_lock;/* protects next_completion */
	u32			next_completion;
	rbd_img_callback_t	callback;

	u32			obj_request_count;
	struct list_head	obj_requests;	/* rbd_obj_request structs */

	struct kref		kref;
};

#define for_each_obj_request(ireq, oreq) \
229
	list_for_each_entry(oreq, &(ireq)->obj_requests, links)
A
Alex Elder 已提交
230
#define for_each_obj_request_from(ireq, oreq) \
231
	list_for_each_entry_from(oreq, &(ireq)->obj_requests, links)
A
Alex Elder 已提交
232
#define for_each_obj_request_safe(ireq, oreq, n) \
233
	list_for_each_entry_safe_reverse(oreq, n, &(ireq)->obj_requests, links)
A
Alex Elder 已提交
234

235 236 237
struct rbd_snap {
	struct	device		dev;
	const char		*name;
J
Josh Durgin 已提交
238
	u64			size;
239 240
	struct list_head	node;
	u64			id;
A
Alex Elder 已提交
241
	u64			features;
242 243
};

A
Alex Elder 已提交
244
struct rbd_mapping {
A
Alex Elder 已提交
245
	u64                     size;
A
Alex Elder 已提交
246
	u64                     features;
A
Alex Elder 已提交
247 248 249
	bool			read_only;
};

250 251 252 253
/*
 * a single device
 */
struct rbd_device {
A
Alex Elder 已提交
254
	int			dev_id;		/* blkdev unique id */
255 256 257 258

	int			major;		/* blkdev assigned major */
	struct gendisk		*disk;		/* blkdev's gendisk and rq */

259
	u32			image_format;	/* Either 1 or 2 */
260 261 262 263
	struct rbd_client	*rbd_client;

	char			name[DEV_NAME_LEN]; /* blkdev name, e.g. rbd3 */

264
	spinlock_t		lock;		/* queue, flags, open_count */
265 266

	struct rbd_image_header	header;
267
	unsigned long		flags;		/* possibly lock protected */
268
	struct rbd_spec		*spec;
269

270
	char			*header_name;
271

272 273
	struct ceph_file_layout	layout;

274
	struct ceph_osd_event   *watch_event;
275
	struct rbd_obj_request	*watch_request;
276

277 278 279
	struct rbd_spec		*parent_spec;
	u64			parent_overlap;

280 281
	/* protects updating the header */
	struct rw_semaphore     header_rwsem;
A
Alex Elder 已提交
282 283

	struct rbd_mapping	mapping;
284 285

	struct list_head	node;
286 287 288 289 290 291

	/* list of snapshots */
	struct list_head	snaps;

	/* sysfs related */
	struct device		dev;
292
	unsigned long		open_count;	/* protected by lock */
293 294
};

295 296 297 298 299 300 301
/*
 * Flag bits for rbd_dev->flags.  If atomicity is required,
 * rbd_dev->lock is used to protect access.
 *
 * Currently, only the "removing" flag (which is coupled with the
 * "open_count" field) requires atomic access.
 */
302 303
enum rbd_dev_flags {
	RBD_DEV_FLAG_EXISTS,	/* mapped snapshot has not been deleted */
304
	RBD_DEV_FLAG_REMOVING,	/* this mapping is being removed */
305 306
};

307
static DEFINE_MUTEX(ctl_mutex);	  /* Serialize open/close/setup/teardown */
308

309
static LIST_HEAD(rbd_dev_list);    /* devices */
310 311
static DEFINE_SPINLOCK(rbd_dev_list_lock);

A
Alex Elder 已提交
312 313
static LIST_HEAD(rbd_client_list);		/* clients */
static DEFINE_SPINLOCK(rbd_client_list_lock);
314

315 316 317
static int rbd_dev_snaps_update(struct rbd_device *rbd_dev);
static int rbd_dev_snaps_register(struct rbd_device *rbd_dev);

318
static void rbd_dev_release(struct device *dev);
319
static void rbd_remove_snap_dev(struct rbd_snap *snap);
320

A
Alex Elder 已提交
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
static ssize_t rbd_add(struct bus_type *bus, const char *buf,
		       size_t count);
static ssize_t rbd_remove(struct bus_type *bus, const char *buf,
			  size_t count);

static struct bus_attribute rbd_bus_attrs[] = {
	__ATTR(add, S_IWUSR, NULL, rbd_add),
	__ATTR(remove, S_IWUSR, NULL, rbd_remove),
	__ATTR_NULL
};

static struct bus_type rbd_bus_type = {
	.name		= "rbd",
	.bus_attrs	= rbd_bus_attrs,
};

static void rbd_root_dev_release(struct device *dev)
{
}

static struct device rbd_root_dev = {
	.init_name =    "rbd",
	.release =      rbd_root_dev_release,
};

A
Alex Elder 已提交
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
static __printf(2, 3)
void rbd_warn(struct rbd_device *rbd_dev, const char *fmt, ...)
{
	struct va_format vaf;
	va_list args;

	va_start(args, fmt);
	vaf.fmt = fmt;
	vaf.va = &args;

	if (!rbd_dev)
		printk(KERN_WARNING "%s: %pV\n", RBD_DRV_NAME, &vaf);
	else if (rbd_dev->disk)
		printk(KERN_WARNING "%s: %s: %pV\n",
			RBD_DRV_NAME, rbd_dev->disk->disk_name, &vaf);
	else if (rbd_dev->spec && rbd_dev->spec->image_name)
		printk(KERN_WARNING "%s: image %s: %pV\n",
			RBD_DRV_NAME, rbd_dev->spec->image_name, &vaf);
	else if (rbd_dev->spec && rbd_dev->spec->image_id)
		printk(KERN_WARNING "%s: id %s: %pV\n",
			RBD_DRV_NAME, rbd_dev->spec->image_id, &vaf);
	else	/* punt */
		printk(KERN_WARNING "%s: rbd_dev %p: %pV\n",
			RBD_DRV_NAME, rbd_dev, &vaf);
	va_end(args);
}

A
Alex Elder 已提交
373 374 375 376 377 378 379 380 381 382 383 384
#ifdef RBD_DEBUG
#define rbd_assert(expr)						\
		if (unlikely(!(expr))) {				\
			printk(KERN_ERR "\nAssertion failure in %s() "	\
						"at line %d:\n\n"	\
					"\trbd_assert(%s);\n\n",	\
					__func__, __LINE__, #expr);	\
			BUG();						\
		}
#else /* !RBD_DEBUG */
#  define rbd_assert(expr)	((void) 0)
#endif /* !RBD_DEBUG */
385

A
Alex Elder 已提交
386 387
static int rbd_dev_refresh(struct rbd_device *rbd_dev, u64 *hver);
static int rbd_dev_v2_refresh(struct rbd_device *rbd_dev, u64 *hver);
388

389 390
static int rbd_open(struct block_device *bdev, fmode_t mode)
{
A
Alex Elder 已提交
391
	struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
392
	bool removing = false;
393

A
Alex Elder 已提交
394
	if ((mode & FMODE_WRITE) && rbd_dev->mapping.read_only)
395 396
		return -EROFS;

397
	spin_lock_irq(&rbd_dev->lock);
398 399 400 401
	if (test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags))
		removing = true;
	else
		rbd_dev->open_count++;
402
	spin_unlock_irq(&rbd_dev->lock);
403 404 405
	if (removing)
		return -ENOENT;

406
	mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
A
Alex Elder 已提交
407
	(void) get_device(&rbd_dev->dev);
A
Alex Elder 已提交
408
	set_device_ro(bdev, rbd_dev->mapping.read_only);
409
	mutex_unlock(&ctl_mutex);
410

411 412 413
	return 0;
}

414 415 416
static int rbd_release(struct gendisk *disk, fmode_t mode)
{
	struct rbd_device *rbd_dev = disk->private_data;
417 418
	unsigned long open_count_before;

419
	spin_lock_irq(&rbd_dev->lock);
420
	open_count_before = rbd_dev->open_count--;
421
	spin_unlock_irq(&rbd_dev->lock);
422
	rbd_assert(open_count_before > 0);
423

424
	mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
A
Alex Elder 已提交
425
	put_device(&rbd_dev->dev);
426
	mutex_unlock(&ctl_mutex);
427 428 429 430

	return 0;
}

431 432 433
static const struct block_device_operations rbd_bd_ops = {
	.owner			= THIS_MODULE,
	.open			= rbd_open,
434
	.release		= rbd_release,
435 436 437 438
};

/*
 * Initialize an rbd client instance.
A
Alex Elder 已提交
439
 * We own *ceph_opts.
440
 */
441
static struct rbd_client *rbd_client_create(struct ceph_options *ceph_opts)
442 443 444 445
{
	struct rbd_client *rbdc;
	int ret = -ENOMEM;

A
Alex Elder 已提交
446
	dout("%s:\n", __func__);
447 448 449 450 451 452 453
	rbdc = kmalloc(sizeof(struct rbd_client), GFP_KERNEL);
	if (!rbdc)
		goto out_opt;

	kref_init(&rbdc->kref);
	INIT_LIST_HEAD(&rbdc->node);

454 455
	mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);

A
Alex Elder 已提交
456
	rbdc->client = ceph_create_client(ceph_opts, rbdc, 0, 0);
457
	if (IS_ERR(rbdc->client))
458
		goto out_mutex;
A
Alex Elder 已提交
459
	ceph_opts = NULL; /* Now rbdc->client is responsible for ceph_opts */
460 461 462 463 464

	ret = ceph_open_session(rbdc->client);
	if (ret < 0)
		goto out_err;

A
Alex Elder 已提交
465
	spin_lock(&rbd_client_list_lock);
466
	list_add_tail(&rbdc->node, &rbd_client_list);
A
Alex Elder 已提交
467
	spin_unlock(&rbd_client_list_lock);
468

469
	mutex_unlock(&ctl_mutex);
A
Alex Elder 已提交
470
	dout("%s: rbdc %p\n", __func__, rbdc);
471

472 473 474 475
	return rbdc;

out_err:
	ceph_destroy_client(rbdc->client);
476 477
out_mutex:
	mutex_unlock(&ctl_mutex);
478 479
	kfree(rbdc);
out_opt:
A
Alex Elder 已提交
480 481
	if (ceph_opts)
		ceph_destroy_options(ceph_opts);
A
Alex Elder 已提交
482 483
	dout("%s: error %d\n", __func__, ret);

V
Vasiliy Kulikov 已提交
484
	return ERR_PTR(ret);
485 486 487
}

/*
488 489
 * Find a ceph client with specific addr and configuration.  If
 * found, bump its reference count.
490
 */
491
static struct rbd_client *rbd_client_find(struct ceph_options *ceph_opts)
492 493
{
	struct rbd_client *client_node;
494
	bool found = false;
495

A
Alex Elder 已提交
496
	if (ceph_opts->flags & CEPH_OPT_NOSHARE)
497 498
		return NULL;

499 500 501 502 503 504 505 506 507 508 509
	spin_lock(&rbd_client_list_lock);
	list_for_each_entry(client_node, &rbd_client_list, node) {
		if (!ceph_compare_options(ceph_opts, client_node->client)) {
			kref_get(&client_node->kref);
			found = true;
			break;
		}
	}
	spin_unlock(&rbd_client_list_lock);

	return found ? client_node : NULL;
510 511
}

512 513 514 515 516 517 518 519
/*
 * mount options
 */
enum {
	Opt_last_int,
	/* int args above */
	Opt_last_string,
	/* string args above */
A
Alex Elder 已提交
520 521 522 523
	Opt_read_only,
	Opt_read_write,
	/* Boolean args above */
	Opt_last_bool,
524 525
};

A
Alex Elder 已提交
526
static match_table_t rbd_opts_tokens = {
527 528
	/* int args above */
	/* string args above */
A
Alex Elder 已提交
529
	{Opt_read_only, "read_only"},
A
Alex Elder 已提交
530 531 532 533
	{Opt_read_only, "ro"},		/* Alternate spelling */
	{Opt_read_write, "read_write"},
	{Opt_read_write, "rw"},		/* Alternate spelling */
	/* Boolean args above */
534 535 536
	{-1, NULL}
};

A
Alex Elder 已提交
537 538 539 540 541 542
struct rbd_options {
	bool	read_only;
};

#define RBD_READ_ONLY_DEFAULT	false

543 544
static int parse_rbd_opts_token(char *c, void *private)
{
A
Alex Elder 已提交
545
	struct rbd_options *rbd_opts = private;
546 547 548
	substring_t argstr[MAX_OPT_ARGS];
	int token, intval, ret;

A
Alex Elder 已提交
549
	token = match_token(c, rbd_opts_tokens, argstr);
550 551 552 553 554 555 556 557 558 559 560 561 562 563
	if (token < 0)
		return -EINVAL;

	if (token < Opt_last_int) {
		ret = match_int(&argstr[0], &intval);
		if (ret < 0) {
			pr_err("bad mount option arg (not int) "
			       "at '%s'\n", c);
			return ret;
		}
		dout("got int token %d val %d\n", token, intval);
	} else if (token > Opt_last_int && token < Opt_last_string) {
		dout("got string token %d val %s\n", token,
		     argstr[0].from);
A
Alex Elder 已提交
564 565
	} else if (token > Opt_last_string && token < Opt_last_bool) {
		dout("got Boolean token %d\n", token);
566 567 568 569 570
	} else {
		dout("got token %d\n", token);
	}

	switch (token) {
A
Alex Elder 已提交
571 572 573 574 575 576
	case Opt_read_only:
		rbd_opts->read_only = true;
		break;
	case Opt_read_write:
		rbd_opts->read_only = false;
		break;
577
	default:
A
Alex Elder 已提交
578 579
		rbd_assert(false);
		break;
580 581 582 583
	}
	return 0;
}

584 585 586 587
/*
 * Get a ceph client with specific addr and configuration, if one does
 * not exist create it.
 */
588
static struct rbd_client *rbd_get_client(struct ceph_options *ceph_opts)
589
{
590
	struct rbd_client *rbdc;
591

592
	rbdc = rbd_client_find(ceph_opts);
593
	if (rbdc)	/* using an existing client */
A
Alex Elder 已提交
594
		ceph_destroy_options(ceph_opts);
595
	else
596
		rbdc = rbd_client_create(ceph_opts);
597

598
	return rbdc;
599 600 601 602
}

/*
 * Destroy ceph client
A
Alex Elder 已提交
603
 *
A
Alex Elder 已提交
604
 * Caller must hold rbd_client_list_lock.
605 606 607 608 609
 */
static void rbd_client_release(struct kref *kref)
{
	struct rbd_client *rbdc = container_of(kref, struct rbd_client, kref);

A
Alex Elder 已提交
610
	dout("%s: rbdc %p\n", __func__, rbdc);
611
	spin_lock(&rbd_client_list_lock);
612
	list_del(&rbdc->node);
613
	spin_unlock(&rbd_client_list_lock);
614 615 616 617 618 619 620 621 622

	ceph_destroy_client(rbdc->client);
	kfree(rbdc);
}

/*
 * Drop reference to ceph client node. If it's not referenced anymore, release
 * it.
 */
623
static void rbd_put_client(struct rbd_client *rbdc)
624
{
625 626
	if (rbdc)
		kref_put(&rbdc->kref, rbd_client_release);
627 628
}

629 630 631 632 633
static bool rbd_image_format_valid(u32 image_format)
{
	return image_format == 1 || image_format == 2;
}

634 635
static bool rbd_dev_ondisk_valid(struct rbd_image_header_ondisk *ondisk)
{
636 637 638 639 640 641 642
	size_t size;
	u32 snap_count;

	/* The header has to start with the magic rbd header text */
	if (memcmp(&ondisk->text, RBD_HEADER_TEXT, sizeof (RBD_HEADER_TEXT)))
		return false;

A
Alex Elder 已提交
643 644 645 646 647 648 649 650 651 652
	/* The bio layer requires at least sector-sized I/O */

	if (ondisk->options.order < SECTOR_SHIFT)
		return false;

	/* If we use u64 in a few spots we may be able to loosen this */

	if (ondisk->options.order > 8 * sizeof (int) - 1)
		return false;

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
	/*
	 * The size of a snapshot header has to fit in a size_t, and
	 * that limits the number of snapshots.
	 */
	snap_count = le32_to_cpu(ondisk->snap_count);
	size = SIZE_MAX - sizeof (struct ceph_snap_context);
	if (snap_count > size / sizeof (__le64))
		return false;

	/*
	 * Not only that, but the size of the entire the snapshot
	 * header must also be representable in a size_t.
	 */
	size -= snap_count * sizeof (__le64);
	if ((u64) size < le64_to_cpu(ondisk->snap_names_len))
		return false;

	return true;
671 672
}

673 674 675 676 677
/*
 * Create a new header structure, translate header format from the on-disk
 * header.
 */
static int rbd_header_from_disk(struct rbd_image_header *header,
678
				 struct rbd_image_header_ondisk *ondisk)
679
{
680
	u32 snap_count;
681
	size_t len;
682
	size_t size;
683
	u32 i;
684

A
Alex Elder 已提交
685 686
	memset(header, 0, sizeof (*header));

687 688
	snap_count = le32_to_cpu(ondisk->snap_count);

689 690
	len = strnlen(ondisk->object_prefix, sizeof (ondisk->object_prefix));
	header->object_prefix = kmalloc(len + 1, GFP_KERNEL);
A
Alex Elder 已提交
691
	if (!header->object_prefix)
692
		return -ENOMEM;
693 694
	memcpy(header->object_prefix, ondisk->object_prefix, len);
	header->object_prefix[len] = '\0';
A
Alex Elder 已提交
695

696
	if (snap_count) {
A
Alex Elder 已提交
697 698
		u64 snap_names_len = le64_to_cpu(ondisk->snap_names_len);

699 700
		/* Save a copy of the snapshot names */

A
Alex Elder 已提交
701 702 703
		if (snap_names_len > (u64) SIZE_MAX)
			return -EIO;
		header->snap_names = kmalloc(snap_names_len, GFP_KERNEL);
704
		if (!header->snap_names)
A
Alex Elder 已提交
705
			goto out_err;
A
Alex Elder 已提交
706 707 708 709 710 711 712 713
		/*
		 * Note that rbd_dev_v1_header_read() guarantees
		 * the ondisk buffer we're working with has
		 * snap_names_len bytes beyond the end of the
		 * snapshot id array, this memcpy() is safe.
		 */
		memcpy(header->snap_names, &ondisk->snaps[snap_count],
			snap_names_len);
A
Alex Elder 已提交
714

715 716
		/* Record each snapshot's size */

717 718
		size = snap_count * sizeof (*header->snap_sizes);
		header->snap_sizes = kmalloc(size, GFP_KERNEL);
719
		if (!header->snap_sizes)
A
Alex Elder 已提交
720
			goto out_err;
721 722 723
		for (i = 0; i < snap_count; i++)
			header->snap_sizes[i] =
				le64_to_cpu(ondisk->snaps[i].image_size);
724
	} else {
725
		WARN_ON(ondisk->snap_names_len);
726 727 728
		header->snap_names = NULL;
		header->snap_sizes = NULL;
	}
729

A
Alex Elder 已提交
730
	header->features = 0;	/* No features support in v1 images */
731 732 733
	header->obj_order = ondisk->options.order;
	header->crypt_type = ondisk->options.crypt_type;
	header->comp_type = ondisk->options.comp_type;
A
Alex Elder 已提交
734

735 736
	/* Allocate and fill in the snapshot context */

A
Alex Elder 已提交
737
	header->image_size = le64_to_cpu(ondisk->image_size);
A
Alex Elder 已提交
738 739 740 741 742
	size = sizeof (struct ceph_snap_context);
	size += snap_count * sizeof (header->snapc->snaps[0]);
	header->snapc = kzalloc(size, GFP_KERNEL);
	if (!header->snapc)
		goto out_err;
743 744

	atomic_set(&header->snapc->nref, 1);
745
	header->snapc->seq = le64_to_cpu(ondisk->snap_seq);
746
	header->snapc->num_snaps = snap_count;
747 748 749
	for (i = 0; i < snap_count; i++)
		header->snapc->snaps[i] =
			le64_to_cpu(ondisk->snaps[i].id);
750 751 752

	return 0;

A
Alex Elder 已提交
753
out_err:
754
	kfree(header->snap_sizes);
755
	header->snap_sizes = NULL;
756
	kfree(header->snap_names);
757
	header->snap_names = NULL;
A
Alex Elder 已提交
758 759
	kfree(header->object_prefix);
	header->object_prefix = NULL;
760

A
Alex Elder 已提交
761
	return -ENOMEM;
762 763
}

764 765 766 767 768 769 770 771 772 773 774 775 776 777
static const char *rbd_snap_name(struct rbd_device *rbd_dev, u64 snap_id)
{
	struct rbd_snap *snap;

	if (snap_id == CEPH_NOSNAP)
		return RBD_SNAP_HEAD_NAME;

	list_for_each_entry(snap, &rbd_dev->snaps, node)
		if (snap_id == snap->id)
			return snap->name;

	return NULL;
}

778
static int snap_by_name(struct rbd_device *rbd_dev, const char *snap_name)
779 780
{

781
	struct rbd_snap *snap;
782

783 784
	list_for_each_entry(snap, &rbd_dev->snaps, node) {
		if (!strcmp(snap_name, snap->name)) {
785
			rbd_dev->spec->snap_id = snap->id;
786
			rbd_dev->mapping.size = snap->size;
A
Alex Elder 已提交
787
			rbd_dev->mapping.features = snap->features;
788

789
			return 0;
A
Alex Elder 已提交
790 791
		}
	}
792

A
Alex Elder 已提交
793
	return -ENOENT;
794 795
}

796
static int rbd_dev_set_mapping(struct rbd_device *rbd_dev)
797
{
798
	int ret;
799

800
	if (!memcmp(rbd_dev->spec->snap_name, RBD_SNAP_HEAD_NAME,
801
		    sizeof (RBD_SNAP_HEAD_NAME))) {
802
		rbd_dev->spec->snap_id = CEPH_NOSNAP;
A
Alex Elder 已提交
803
		rbd_dev->mapping.size = rbd_dev->header.image_size;
A
Alex Elder 已提交
804
		rbd_dev->mapping.features = rbd_dev->header.features;
805
		ret = 0;
806
	} else {
807
		ret = snap_by_name(rbd_dev, rbd_dev->spec->snap_name);
808 809
		if (ret < 0)
			goto done;
A
Alex Elder 已提交
810
		rbd_dev->mapping.read_only = true;
811
	}
812 813
	set_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);

814 815 816 817 818 819
done:
	return ret;
}

static void rbd_header_free(struct rbd_image_header *header)
{
820
	kfree(header->object_prefix);
821
	header->object_prefix = NULL;
822
	kfree(header->snap_sizes);
823
	header->snap_sizes = NULL;
824
	kfree(header->snap_names);
825
	header->snap_names = NULL;
826
	ceph_put_snap_context(header->snapc);
827
	header->snapc = NULL;
828 829
}

A
Alex Elder 已提交
830
static const char *rbd_segment_name(struct rbd_device *rbd_dev, u64 offset)
831
{
A
Alex Elder 已提交
832 833 834
	char *name;
	u64 segment;
	int ret;
835

A
Alex Elder 已提交
836
	name = kmalloc(MAX_OBJ_NAME_SIZE + 1, GFP_NOIO);
A
Alex Elder 已提交
837 838 839
	if (!name)
		return NULL;
	segment = offset >> rbd_dev->header.obj_order;
A
Alex Elder 已提交
840
	ret = snprintf(name, MAX_OBJ_NAME_SIZE + 1, "%s.%012llx",
A
Alex Elder 已提交
841
			rbd_dev->header.object_prefix, segment);
A
Alex Elder 已提交
842
	if (ret < 0 || ret > MAX_OBJ_NAME_SIZE) {
A
Alex Elder 已提交
843 844 845 846 847
		pr_err("error formatting segment name for #%llu (%d)\n",
			segment, ret);
		kfree(name);
		name = NULL;
	}
848

A
Alex Elder 已提交
849 850
	return name;
}
851

A
Alex Elder 已提交
852 853 854
static u64 rbd_segment_offset(struct rbd_device *rbd_dev, u64 offset)
{
	u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
855

A
Alex Elder 已提交
856 857 858 859 860 861 862 863 864 865
	return offset & (segment_size - 1);
}

static u64 rbd_segment_length(struct rbd_device *rbd_dev,
				u64 offset, u64 length)
{
	u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;

	offset &= segment_size - 1;

A
Alex Elder 已提交
866
	rbd_assert(length <= U64_MAX - offset);
A
Alex Elder 已提交
867 868 869 870
	if (offset + length > segment_size)
		length = segment_size - offset;

	return length;
871 872
}

873 874 875 876 877 878 879 880
/*
 * returns the size of an object in the image
 */
static u64 rbd_obj_bytes(struct rbd_image_header *header)
{
	return 1 << header->obj_order;
}

881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
/*
 * bio helpers
 */

static void bio_chain_put(struct bio *chain)
{
	struct bio *tmp;

	while (chain) {
		tmp = chain;
		chain = chain->bi_next;
		bio_put(tmp);
	}
}

/*
 * zeros a bio chain, starting at specific offset
 */
static void zero_bio_chain(struct bio *chain, int start_ofs)
{
	struct bio_vec *bv;
	unsigned long flags;
	void *buf;
	int i;
	int pos = 0;

	while (chain) {
		bio_for_each_segment(bv, chain, i) {
			if (pos + bv->bv_len > start_ofs) {
				int remainder = max(start_ofs - pos, 0);
				buf = bvec_kmap_irq(bv, &flags);
				memset(buf + remainder, 0,
				       bv->bv_len - remainder);
914
				bvec_kunmap_irq(buf, &flags);
915 916 917 918 919 920 921 922 923
			}
			pos += bv->bv_len;
		}

		chain = chain->bi_next;
	}
}

/*
A
Alex Elder 已提交
924 925
 * Clone a portion of a bio, starting at the given byte offset
 * and continuing for the number of bytes indicated.
926
 */
A
Alex Elder 已提交
927 928 929 930
static struct bio *bio_clone_range(struct bio *bio_src,
					unsigned int offset,
					unsigned int len,
					gfp_t gfpmask)
931
{
A
Alex Elder 已提交
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
	struct bio_vec *bv;
	unsigned int resid;
	unsigned short idx;
	unsigned int voff;
	unsigned short end_idx;
	unsigned short vcnt;
	struct bio *bio;

	/* Handle the easy case for the caller */

	if (!offset && len == bio_src->bi_size)
		return bio_clone(bio_src, gfpmask);

	if (WARN_ON_ONCE(!len))
		return NULL;
	if (WARN_ON_ONCE(len > bio_src->bi_size))
		return NULL;
	if (WARN_ON_ONCE(offset > bio_src->bi_size - len))
		return NULL;

	/* Find first affected segment... */

	resid = offset;
	__bio_for_each_segment(bv, bio_src, idx, 0) {
		if (resid < bv->bv_len)
			break;
		resid -= bv->bv_len;
959
	}
A
Alex Elder 已提交
960
	voff = resid;
961

A
Alex Elder 已提交
962
	/* ...and the last affected segment */
963

A
Alex Elder 已提交
964 965 966 967 968 969 970 971 972 973 974 975 976
	resid += len;
	__bio_for_each_segment(bv, bio_src, end_idx, idx) {
		if (resid <= bv->bv_len)
			break;
		resid -= bv->bv_len;
	}
	vcnt = end_idx - idx + 1;

	/* Build the clone */

	bio = bio_alloc(gfpmask, (unsigned int) vcnt);
	if (!bio)
		return NULL;	/* ENOMEM */
977

A
Alex Elder 已提交
978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
	bio->bi_bdev = bio_src->bi_bdev;
	bio->bi_sector = bio_src->bi_sector + (offset >> SECTOR_SHIFT);
	bio->bi_rw = bio_src->bi_rw;
	bio->bi_flags |= 1 << BIO_CLONED;

	/*
	 * Copy over our part of the bio_vec, then update the first
	 * and last (or only) entries.
	 */
	memcpy(&bio->bi_io_vec[0], &bio_src->bi_io_vec[idx],
			vcnt * sizeof (struct bio_vec));
	bio->bi_io_vec[0].bv_offset += voff;
	if (vcnt > 1) {
		bio->bi_io_vec[0].bv_len -= voff;
		bio->bi_io_vec[vcnt - 1].bv_len = resid;
	} else {
		bio->bi_io_vec[0].bv_len = len;
995 996
	}

A
Alex Elder 已提交
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
	bio->bi_vcnt = vcnt;
	bio->bi_size = len;
	bio->bi_idx = 0;

	return bio;
}

/*
 * Clone a portion of a bio chain, starting at the given byte offset
 * into the first bio in the source chain and continuing for the
 * number of bytes indicated.  The result is another bio chain of
 * exactly the given length, or a null pointer on error.
 *
 * The bio_src and offset parameters are both in-out.  On entry they
 * refer to the first source bio and the offset into that bio where
 * the start of data to be cloned is located.
 *
 * On return, bio_src is updated to refer to the bio in the source
 * chain that contains first un-cloned byte, and *offset will
 * contain the offset of that byte within that bio.
 */
static struct bio *bio_chain_clone_range(struct bio **bio_src,
					unsigned int *offset,
					unsigned int len,
					gfp_t gfpmask)
{
	struct bio *bi = *bio_src;
	unsigned int off = *offset;
	struct bio *chain = NULL;
	struct bio **end;

	/* Build up a chain of clone bios up to the limit */

	if (!bi || off >= bi->bi_size || !len)
		return NULL;		/* Nothing to clone */
1032

A
Alex Elder 已提交
1033 1034 1035 1036 1037
	end = &chain;
	while (len) {
		unsigned int bi_size;
		struct bio *bio;

1038 1039
		if (!bi) {
			rbd_warn(NULL, "bio_chain exhausted with %u left", len);
A
Alex Elder 已提交
1040
			goto out_err;	/* EINVAL; ran out of bio's */
1041
		}
A
Alex Elder 已提交
1042 1043 1044 1045 1046 1047 1048
		bi_size = min_t(unsigned int, bi->bi_size - off, len);
		bio = bio_clone_range(bi, off, bi_size, gfpmask);
		if (!bio)
			goto out_err;	/* ENOMEM */

		*end = bio;
		end = &bio->bi_next;
1049

A
Alex Elder 已提交
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
		off += bi_size;
		if (off == bi->bi_size) {
			bi = bi->bi_next;
			off = 0;
		}
		len -= bi_size;
	}
	*bio_src = bi;
	*offset = off;

	return chain;
out_err:
	bio_chain_put(chain);
1063 1064 1065 1066

	return NULL;
}

A
Alex Elder 已提交
1067 1068
static void rbd_obj_request_get(struct rbd_obj_request *obj_request)
{
A
Alex Elder 已提交
1069 1070
	dout("%s: obj %p (was %d)\n", __func__, obj_request,
		atomic_read(&obj_request->kref.refcount));
A
Alex Elder 已提交
1071 1072 1073 1074 1075 1076 1077
	kref_get(&obj_request->kref);
}

static void rbd_obj_request_destroy(struct kref *kref);
static void rbd_obj_request_put(struct rbd_obj_request *obj_request)
{
	rbd_assert(obj_request != NULL);
A
Alex Elder 已提交
1078 1079
	dout("%s: obj %p (was %d)\n", __func__, obj_request,
		atomic_read(&obj_request->kref.refcount));
A
Alex Elder 已提交
1080 1081 1082 1083 1084
	kref_put(&obj_request->kref, rbd_obj_request_destroy);
}

static void rbd_img_request_get(struct rbd_img_request *img_request)
{
A
Alex Elder 已提交
1085 1086
	dout("%s: img %p (was %d)\n", __func__, img_request,
		atomic_read(&img_request->kref.refcount));
A
Alex Elder 已提交
1087 1088 1089 1090 1091 1092 1093
	kref_get(&img_request->kref);
}

static void rbd_img_request_destroy(struct kref *kref);
static void rbd_img_request_put(struct rbd_img_request *img_request)
{
	rbd_assert(img_request != NULL);
A
Alex Elder 已提交
1094 1095
	dout("%s: img %p (was %d)\n", __func__, img_request,
		atomic_read(&img_request->kref.refcount));
A
Alex Elder 已提交
1096 1097 1098 1099 1100 1101
	kref_put(&img_request->kref, rbd_img_request_destroy);
}

static inline void rbd_img_obj_request_add(struct rbd_img_request *img_request,
					struct rbd_obj_request *obj_request)
{
1102 1103
	rbd_assert(obj_request->img_request == NULL);

A
Alex Elder 已提交
1104 1105
	rbd_obj_request_get(obj_request);
	obj_request->img_request = img_request;
1106
	obj_request->which = img_request->obj_request_count;
A
Alex Elder 已提交
1107
	rbd_assert(obj_request->which != BAD_WHICH);
1108 1109
	img_request->obj_request_count++;
	list_add_tail(&obj_request->links, &img_request->obj_requests);
A
Alex Elder 已提交
1110 1111
	dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
		obj_request->which);
A
Alex Elder 已提交
1112 1113 1114 1115 1116 1117
}

static inline void rbd_img_obj_request_del(struct rbd_img_request *img_request,
					struct rbd_obj_request *obj_request)
{
	rbd_assert(obj_request->which != BAD_WHICH);
1118

A
Alex Elder 已提交
1119 1120
	dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
		obj_request->which);
A
Alex Elder 已提交
1121
	list_del(&obj_request->links);
1122 1123 1124 1125
	rbd_assert(img_request->obj_request_count > 0);
	img_request->obj_request_count--;
	rbd_assert(obj_request->which == img_request->obj_request_count);
	obj_request->which = BAD_WHICH;
A
Alex Elder 已提交
1126 1127
	rbd_assert(obj_request->img_request == img_request);
	obj_request->img_request = NULL;
1128
	obj_request->callback = NULL;
A
Alex Elder 已提交
1129 1130 1131 1132 1133 1134
	rbd_obj_request_put(obj_request);
}

static bool obj_request_type_valid(enum obj_request_type type)
{
	switch (type) {
1135
	case OBJ_REQUEST_NODATA:
A
Alex Elder 已提交
1136
	case OBJ_REQUEST_BIO:
1137
	case OBJ_REQUEST_PAGES:
A
Alex Elder 已提交
1138 1139 1140 1141 1142 1143
		return true;
	default:
		return false;
	}
}

A
Alex Elder 已提交
1144
static struct ceph_osd_req_op *rbd_osd_req_op_create(u16 opcode, ...)
1145 1146 1147
{
	struct ceph_osd_req_op *op;
	va_list args;
1148
	size_t size;
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

	op = kzalloc(sizeof (*op), GFP_NOIO);
	if (!op)
		return NULL;
	op->op = opcode;
	va_start(args, opcode);
	switch (opcode) {
	case CEPH_OSD_OP_READ:
	case CEPH_OSD_OP_WRITE:
		/* rbd_osd_req_op_create(READ, offset, length) */
		/* rbd_osd_req_op_create(WRITE, offset, length) */
		op->extent.offset = va_arg(args, u64);
		op->extent.length = va_arg(args, u64);
		if (opcode == CEPH_OSD_OP_WRITE)
			op->payload_len = op->extent.length;
		break;
A
Alex Elder 已提交
1165 1166
	case CEPH_OSD_OP_STAT:
		break;
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
	case CEPH_OSD_OP_CALL:
		/* rbd_osd_req_op_create(CALL, class, method, data, datalen) */
		op->cls.class_name = va_arg(args, char *);
		size = strlen(op->cls.class_name);
		rbd_assert(size <= (size_t) U8_MAX);
		op->cls.class_len = size;
		op->payload_len = size;

		op->cls.method_name = va_arg(args, char *);
		size = strlen(op->cls.method_name);
		rbd_assert(size <= (size_t) U8_MAX);
		op->cls.method_len = size;
		op->payload_len += size;

		op->cls.argc = 0;
		op->cls.indata = va_arg(args, void *);
		size = va_arg(args, size_t);
		rbd_assert(size <= (size_t) U32_MAX);
		op->cls.indata_len = (u32) size;
		op->payload_len += size;
		break;
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
	case CEPH_OSD_OP_NOTIFY_ACK:
	case CEPH_OSD_OP_WATCH:
		/* rbd_osd_req_op_create(NOTIFY_ACK, cookie, version) */
		/* rbd_osd_req_op_create(WATCH, cookie, version, flag) */
		op->watch.cookie = va_arg(args, u64);
		op->watch.ver = va_arg(args, u64);
		op->watch.ver = cpu_to_le64(op->watch.ver);
		if (opcode == CEPH_OSD_OP_WATCH && va_arg(args, int))
			op->watch.flag = (u8) 1;
		break;
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
	default:
		rbd_warn(NULL, "unsupported opcode %hu\n", opcode);
		kfree(op);
		op = NULL;
		break;
	}
	va_end(args);

	return op;
}

static void rbd_osd_req_op_destroy(struct ceph_osd_req_op *op)
{
	kfree(op);
}

A
Alex Elder 已提交
1214 1215 1216
static int rbd_obj_request_submit(struct ceph_osd_client *osdc,
				struct rbd_obj_request *obj_request)
{
A
Alex Elder 已提交
1217 1218
	dout("%s: osdc %p obj %p\n", __func__, osdc, obj_request);

A
Alex Elder 已提交
1219 1220 1221 1222 1223
	return ceph_osdc_start_request(osdc, obj_request->osd_req, false);
}

static void rbd_img_request_complete(struct rbd_img_request *img_request)
{
A
Alex Elder 已提交
1224
	dout("%s: img %p\n", __func__, img_request);
A
Alex Elder 已提交
1225 1226 1227 1228 1229 1230
	if (img_request->callback)
		img_request->callback(img_request);
	else
		rbd_img_request_put(img_request);
}

1231 1232 1233 1234
/* Caller is responsible for rbd_obj_request_destroy(obj_request) */

static int rbd_obj_request_wait(struct rbd_obj_request *obj_request)
{
A
Alex Elder 已提交
1235 1236
	dout("%s: obj %p\n", __func__, obj_request);

1237 1238 1239
	return wait_for_completion_interruptible(&obj_request->completion);
}

1240 1241 1242 1243 1244 1245 1246 1247
static void obj_request_done_init(struct rbd_obj_request *obj_request)
{
	atomic_set(&obj_request->done, 0);
	smp_wmb();
}

static void obj_request_done_set(struct rbd_obj_request *obj_request)
{
A
Alex Elder 已提交
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
	int done;

	done = atomic_inc_return(&obj_request->done);
	if (done > 1) {
		struct rbd_img_request *img_request = obj_request->img_request;
		struct rbd_device *rbd_dev;

		rbd_dev = img_request ? img_request->rbd_dev : NULL;
		rbd_warn(rbd_dev, "obj_request %p was already done\n",
			obj_request);
	}
1259 1260 1261 1262
}

static bool obj_request_done_test(struct rbd_obj_request *obj_request)
{
A
Alex Elder 已提交
1263
	smp_mb();
1264 1265 1266
	return atomic_read(&obj_request->done) != 0;
}

1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292
static void
rbd_img_obj_request_read_callback(struct rbd_obj_request *obj_request)
{
	dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
		obj_request, obj_request->img_request, obj_request->result,
		obj_request->xferred, obj_request->length);
	/*
	 * ENOENT means a hole in the image.  We zero-fill the
	 * entire length of the request.  A short read also implies
	 * zero-fill to the end of the request.  Either way we
	 * update the xferred count to indicate the whole request
	 * was satisfied.
	 */
	BUG_ON(obj_request->type != OBJ_REQUEST_BIO);
	if (obj_request->result == -ENOENT) {
		zero_bio_chain(obj_request->bio_list, 0);
		obj_request->result = 0;
		obj_request->xferred = obj_request->length;
	} else if (obj_request->xferred < obj_request->length &&
			!obj_request->result) {
		zero_bio_chain(obj_request->bio_list, obj_request->xferred);
		obj_request->xferred = obj_request->length;
	}
	obj_request_done_set(obj_request);
}

A
Alex Elder 已提交
1293 1294
static void rbd_obj_request_complete(struct rbd_obj_request *obj_request)
{
A
Alex Elder 已提交
1295 1296
	dout("%s: obj %p cb %p\n", __func__, obj_request,
		obj_request->callback);
A
Alex Elder 已提交
1297 1298
	if (obj_request->callback)
		obj_request->callback(obj_request);
1299 1300
	else
		complete_all(&obj_request->completion);
A
Alex Elder 已提交
1301 1302
}

1303
static void rbd_osd_trivial_callback(struct rbd_obj_request *obj_request)
1304 1305 1306 1307 1308
{
	dout("%s: obj %p\n", __func__, obj_request);
	obj_request_done_set(obj_request);
}

1309
static void rbd_osd_read_callback(struct rbd_obj_request *obj_request)
A
Alex Elder 已提交
1310
{
A
Alex Elder 已提交
1311
	dout("%s: obj %p result %d %llu/%llu\n", __func__, obj_request,
1312
		obj_request->result, obj_request->xferred, obj_request->length);
1313 1314 1315 1316
	if (obj_request->img_request)
		rbd_img_obj_request_read_callback(obj_request);
	else
		obj_request_done_set(obj_request);
A
Alex Elder 已提交
1317 1318
}

1319
static void rbd_osd_write_callback(struct rbd_obj_request *obj_request)
A
Alex Elder 已提交
1320
{
1321 1322 1323 1324 1325 1326 1327 1328
	dout("%s: obj %p result %d %llu\n", __func__, obj_request,
		obj_request->result, obj_request->length);
	/*
	 * There is no such thing as a successful short write.
	 * Our xferred value is the number of bytes transferred
	 * back.  Set it to our originally-requested length.
	 */
	obj_request->xferred = obj_request->length;
1329
	obj_request_done_set(obj_request);
A
Alex Elder 已提交
1330 1331
}

A
Alex Elder 已提交
1332 1333 1334 1335
/*
 * For a simple stat call there's nothing to do.  We'll do more if
 * this is part of a write sequence for a layered image.
 */
1336
static void rbd_osd_stat_callback(struct rbd_obj_request *obj_request)
A
Alex Elder 已提交
1337
{
A
Alex Elder 已提交
1338
	dout("%s: obj %p\n", __func__, obj_request);
A
Alex Elder 已提交
1339 1340 1341
	obj_request_done_set(obj_request);
}

A
Alex Elder 已提交
1342 1343 1344 1345 1346 1347
static void rbd_osd_req_callback(struct ceph_osd_request *osd_req,
				struct ceph_msg *msg)
{
	struct rbd_obj_request *obj_request = osd_req->r_priv;
	u16 opcode;

A
Alex Elder 已提交
1348
	dout("%s: osd_req %p msg %p\n", __func__, osd_req, msg);
A
Alex Elder 已提交
1349 1350 1351 1352
	rbd_assert(osd_req == obj_request->osd_req);
	rbd_assert(!!obj_request->img_request ^
				(obj_request->which == BAD_WHICH));

1353 1354
	if (osd_req->r_result < 0)
		obj_request->result = osd_req->r_result;
A
Alex Elder 已提交
1355 1356
	obj_request->version = le64_to_cpu(osd_req->r_reassert_version.version);

1357
	WARN_ON(osd_req->r_num_ops != 1);	/* For now */
A
Alex Elder 已提交
1358

1359 1360 1361 1362
	/*
	 * We support a 64-bit length, but ultimately it has to be
	 * passed to blk_end_request(), which takes an unsigned int.
	 */
1363
	obj_request->xferred = osd_req->r_reply_op_len[0];
1364
	rbd_assert(obj_request->xferred < (u64) UINT_MAX);
1365
	opcode = osd_req->r_request_ops[0].op;
A
Alex Elder 已提交
1366 1367
	switch (opcode) {
	case CEPH_OSD_OP_READ:
1368
		rbd_osd_read_callback(obj_request);
A
Alex Elder 已提交
1369 1370
		break;
	case CEPH_OSD_OP_WRITE:
1371
		rbd_osd_write_callback(obj_request);
A
Alex Elder 已提交
1372
		break;
A
Alex Elder 已提交
1373
	case CEPH_OSD_OP_STAT:
1374
		rbd_osd_stat_callback(obj_request);
A
Alex Elder 已提交
1375
		break;
1376
	case CEPH_OSD_OP_CALL:
A
Alex Elder 已提交
1377
	case CEPH_OSD_OP_NOTIFY_ACK:
1378
	case CEPH_OSD_OP_WATCH:
1379
		rbd_osd_trivial_callback(obj_request);
1380
		break;
A
Alex Elder 已提交
1381 1382 1383 1384 1385 1386
	default:
		rbd_warn(NULL, "%s: unsupported op %hu\n",
			obj_request->object_name, (unsigned short) opcode);
		break;
	}

1387
	if (obj_request_done_test(obj_request))
A
Alex Elder 已提交
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
		rbd_obj_request_complete(obj_request);
}

static struct ceph_osd_request *rbd_osd_req_create(
					struct rbd_device *rbd_dev,
					bool write_request,
					struct rbd_obj_request *obj_request,
					struct ceph_osd_req_op *op)
{
	struct rbd_img_request *img_request = obj_request->img_request;
	struct ceph_snap_context *snapc = NULL;
	struct ceph_osd_client *osdc;
	struct ceph_osd_request *osd_req;
1401
	struct ceph_osd_data *osd_data;
A
Alex Elder 已提交
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
	struct timespec now;
	struct timespec *mtime;
	u64 snap_id = CEPH_NOSNAP;
	u64 offset = obj_request->offset;
	u64 length = obj_request->length;

	if (img_request) {
		rbd_assert(img_request->write_request == write_request);
		if (img_request->write_request)
			snapc = img_request->snapc;
		else
			snap_id = img_request->snap_id;
	}

	/* Allocate and initialize the request, for the single op */

	osdc = &rbd_dev->rbd_client->client->osdc;
	osd_req = ceph_osdc_alloc_request(osdc, snapc, 1, false, GFP_ATOMIC);
	if (!osd_req)
		return NULL;	/* ENOMEM */
1422
	osd_data = write_request ? &osd_req->r_data_out : &osd_req->r_data_in;
A
Alex Elder 已提交
1423 1424 1425

	rbd_assert(obj_request_type_valid(obj_request->type));
	switch (obj_request->type) {
1426 1427
	case OBJ_REQUEST_NODATA:
		break;		/* Nothing to do */
A
Alex Elder 已提交
1428 1429
	case OBJ_REQUEST_BIO:
		rbd_assert(obj_request->bio_list != NULL);
1430 1431
		osd_data->type = CEPH_OSD_DATA_TYPE_BIO;
		osd_data->bio = obj_request->bio_list;
A
Alex Elder 已提交
1432
		break;
1433
	case OBJ_REQUEST_PAGES:
1434 1435 1436 1437 1438 1439
		osd_data->type = CEPH_OSD_DATA_TYPE_PAGES;
		osd_data->pages = obj_request->pages;
		osd_data->num_pages = obj_request->page_count;
		osd_data->alignment = offset & ~PAGE_MASK;
		osd_data->pages_from_pool = false;
		osd_data->own_pages = false;
1440
		break;
A
Alex Elder 已提交
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
	}

	if (write_request) {
		osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
		now = CURRENT_TIME;
		mtime = &now;
	} else {
		osd_req->r_flags = CEPH_OSD_FLAG_READ;
		mtime = NULL;	/* not needed for reads */
		offset = 0;	/* These are not used... */
		length = 0;	/* ...for osd read requests */
	}

	osd_req->r_callback = rbd_osd_req_callback;
	osd_req->r_priv = obj_request;

	osd_req->r_oid_len = strlen(obj_request->object_name);
	rbd_assert(osd_req->r_oid_len < sizeof (osd_req->r_oid));
	memcpy(osd_req->r_oid, obj_request->object_name, osd_req->r_oid_len);

	osd_req->r_file_layout = rbd_dev->layout;	/* struct */

	/* osd_req will get its own reference to snapc (if non-null) */

	ceph_osdc_build_request(osd_req, offset, length, 1, op,
				snapc, snap_id, mtime);

	return osd_req;
}

static void rbd_osd_req_destroy(struct ceph_osd_request *osd_req)
{
	ceph_osdc_put_request(osd_req);
}

/* object_name is assumed to be a non-null pointer and NUL-terminated */

static struct rbd_obj_request *rbd_obj_request_create(const char *object_name,
						u64 offset, u64 length,
						enum obj_request_type type)
{
	struct rbd_obj_request *obj_request;
	size_t size;
	char *name;

	rbd_assert(obj_request_type_valid(type));

	size = strlen(object_name) + 1;
	obj_request = kzalloc(sizeof (*obj_request) + size, GFP_KERNEL);
	if (!obj_request)
		return NULL;

	name = (char *)(obj_request + 1);
	obj_request->object_name = memcpy(name, object_name, size);
	obj_request->offset = offset;
	obj_request->length = length;
	obj_request->which = BAD_WHICH;
	obj_request->type = type;
	INIT_LIST_HEAD(&obj_request->links);
1500
	obj_request_done_init(obj_request);
1501
	init_completion(&obj_request->completion);
A
Alex Elder 已提交
1502 1503
	kref_init(&obj_request->kref);

A
Alex Elder 已提交
1504 1505 1506
	dout("%s: \"%s\" %llu/%llu %d -> obj %p\n", __func__, object_name,
		offset, length, (int)type, obj_request);

A
Alex Elder 已提交
1507 1508 1509 1510 1511 1512 1513 1514 1515
	return obj_request;
}

static void rbd_obj_request_destroy(struct kref *kref)
{
	struct rbd_obj_request *obj_request;

	obj_request = container_of(kref, struct rbd_obj_request, kref);

A
Alex Elder 已提交
1516 1517
	dout("%s: obj %p\n", __func__, obj_request);

A
Alex Elder 已提交
1518 1519 1520 1521 1522 1523 1524 1525
	rbd_assert(obj_request->img_request == NULL);
	rbd_assert(obj_request->which == BAD_WHICH);

	if (obj_request->osd_req)
		rbd_osd_req_destroy(obj_request->osd_req);

	rbd_assert(obj_request_type_valid(obj_request->type));
	switch (obj_request->type) {
1526 1527
	case OBJ_REQUEST_NODATA:
		break;		/* Nothing to do */
A
Alex Elder 已提交
1528 1529 1530 1531
	case OBJ_REQUEST_BIO:
		if (obj_request->bio_list)
			bio_chain_put(obj_request->bio_list);
		break;
1532 1533 1534 1535 1536
	case OBJ_REQUEST_PAGES:
		if (obj_request->pages)
			ceph_release_page_vector(obj_request->pages,
						obj_request->page_count);
		break;
A
Alex Elder 已提交
1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
	}

	kfree(obj_request);
}

/*
 * Caller is responsible for filling in the list of object requests
 * that comprises the image request, and the Linux request pointer
 * (if there is one).
 */
A
Alex Elder 已提交
1547 1548
static struct rbd_img_request *rbd_img_request_create(
					struct rbd_device *rbd_dev,
A
Alex Elder 已提交
1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
					u64 offset, u64 length,
					bool write_request)
{
	struct rbd_img_request *img_request;
	struct ceph_snap_context *snapc = NULL;

	img_request = kmalloc(sizeof (*img_request), GFP_ATOMIC);
	if (!img_request)
		return NULL;

	if (write_request) {
		down_read(&rbd_dev->header_rwsem);
		snapc = ceph_get_snap_context(rbd_dev->header.snapc);
		up_read(&rbd_dev->header_rwsem);
		if (WARN_ON(!snapc)) {
			kfree(img_request);
			return NULL;	/* Shouldn't happen */
		}
	}

	img_request->rq = NULL;
	img_request->rbd_dev = rbd_dev;
	img_request->offset = offset;
	img_request->length = length;
	img_request->write_request = write_request;
	if (write_request)
		img_request->snapc = snapc;
	else
		img_request->snap_id = rbd_dev->spec->snap_id;
	spin_lock_init(&img_request->completion_lock);
	img_request->next_completion = 0;
	img_request->callback = NULL;
	img_request->obj_request_count = 0;
	INIT_LIST_HEAD(&img_request->obj_requests);
	kref_init(&img_request->kref);

	rbd_img_request_get(img_request);	/* Avoid a warning */
	rbd_img_request_put(img_request);	/* TEMPORARY */

A
Alex Elder 已提交
1588 1589 1590 1591
	dout("%s: rbd_dev %p %s %llu/%llu -> img %p\n", __func__, rbd_dev,
		write_request ? "write" : "read", offset, length,
		img_request);

A
Alex Elder 已提交
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
	return img_request;
}

static void rbd_img_request_destroy(struct kref *kref)
{
	struct rbd_img_request *img_request;
	struct rbd_obj_request *obj_request;
	struct rbd_obj_request *next_obj_request;

	img_request = container_of(kref, struct rbd_img_request, kref);

A
Alex Elder 已提交
1603 1604
	dout("%s: img %p\n", __func__, img_request);

A
Alex Elder 已提交
1605 1606
	for_each_obj_request_safe(img_request, obj_request, next_obj_request)
		rbd_img_obj_request_del(img_request, obj_request);
1607
	rbd_assert(img_request->obj_request_count == 0);
A
Alex Elder 已提交
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625

	if (img_request->write_request)
		ceph_put_snap_context(img_request->snapc);

	kfree(img_request);
}

static int rbd_img_request_fill_bio(struct rbd_img_request *img_request,
					struct bio *bio_list)
{
	struct rbd_device *rbd_dev = img_request->rbd_dev;
	struct rbd_obj_request *obj_request = NULL;
	struct rbd_obj_request *next_obj_request;
	unsigned int bio_offset;
	u64 image_offset;
	u64 resid;
	u16 opcode;

A
Alex Elder 已提交
1626 1627
	dout("%s: img %p bio %p\n", __func__, img_request, bio_list);

A
Alex Elder 已提交
1628 1629 1630 1631 1632 1633
	opcode = img_request->write_request ? CEPH_OSD_OP_WRITE
					      : CEPH_OSD_OP_READ;
	bio_offset = 0;
	image_offset = img_request->offset;
	rbd_assert(image_offset == bio_list->bi_sector << SECTOR_SHIFT);
	resid = img_request->length;
A
Alex Elder 已提交
1634
	rbd_assert(resid > 0);
A
Alex Elder 已提交
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
	while (resid) {
		const char *object_name;
		unsigned int clone_size;
		struct ceph_osd_req_op *op;
		u64 offset;
		u64 length;

		object_name = rbd_segment_name(rbd_dev, image_offset);
		if (!object_name)
			goto out_unwind;
		offset = rbd_segment_offset(rbd_dev, image_offset);
		length = rbd_segment_length(rbd_dev, image_offset, resid);
		obj_request = rbd_obj_request_create(object_name,
						offset, length,
						OBJ_REQUEST_BIO);
		kfree(object_name);	/* object request has its own copy */
		if (!obj_request)
			goto out_unwind;

		rbd_assert(length <= (u64) UINT_MAX);
		clone_size = (unsigned int) length;
		obj_request->bio_list = bio_chain_clone_range(&bio_list,
						&bio_offset, clone_size,
						GFP_ATOMIC);
		if (!obj_request->bio_list)
			goto out_partial;

		/*
		 * Build up the op to use in building the osd
		 * request.  Note that the contents of the op are
		 * copied by rbd_osd_req_create().
		 */
		op = rbd_osd_req_op_create(opcode, offset, length);
		if (!op)
			goto out_partial;
		obj_request->osd_req = rbd_osd_req_create(rbd_dev,
						img_request->write_request,
						obj_request, op);
		rbd_osd_req_op_destroy(op);
		if (!obj_request->osd_req)
			goto out_partial;
		/* status and version are initially zero-filled */

		rbd_img_obj_request_add(img_request, obj_request);

		image_offset += length;
		resid -= length;
	}

	return 0;

out_partial:
	rbd_obj_request_put(obj_request);
out_unwind:
	for_each_obj_request_safe(img_request, obj_request, next_obj_request)
		rbd_obj_request_put(obj_request);

	return -ENOMEM;
}

static void rbd_img_obj_callback(struct rbd_obj_request *obj_request)
{
	struct rbd_img_request *img_request;
	u32 which = obj_request->which;
	bool more = true;

	img_request = obj_request->img_request;
A
Alex Elder 已提交
1702

A
Alex Elder 已提交
1703
	dout("%s: img %p obj %p\n", __func__, img_request, obj_request);
A
Alex Elder 已提交
1704 1705
	rbd_assert(img_request != NULL);
	rbd_assert(img_request->rq != NULL);
A
Alex Elder 已提交
1706
	rbd_assert(img_request->obj_request_count > 0);
A
Alex Elder 已提交
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721
	rbd_assert(which != BAD_WHICH);
	rbd_assert(which < img_request->obj_request_count);
	rbd_assert(which >= img_request->next_completion);

	spin_lock_irq(&img_request->completion_lock);
	if (which != img_request->next_completion)
		goto out;

	for_each_obj_request_from(img_request, obj_request) {
		unsigned int xferred;
		int result;

		rbd_assert(more);
		rbd_assert(which < img_request->obj_request_count);

1722
		if (!obj_request_done_test(obj_request))
A
Alex Elder 已提交
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
			break;

		rbd_assert(obj_request->xferred <= (u64) UINT_MAX);
		xferred = (unsigned int) obj_request->xferred;
		result = (int) obj_request->result;
		if (result)
			rbd_warn(NULL, "obj_request %s result %d xferred %u\n",
				img_request->write_request ? "write" : "read",
				result, xferred);

		more = blk_end_request(img_request->rq, result, xferred);
		which++;
	}
1736

A
Alex Elder 已提交
1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
	rbd_assert(more ^ (which == img_request->obj_request_count));
	img_request->next_completion = which;
out:
	spin_unlock_irq(&img_request->completion_lock);

	if (!more)
		rbd_img_request_complete(img_request);
}

static int rbd_img_request_submit(struct rbd_img_request *img_request)
{
	struct rbd_device *rbd_dev = img_request->rbd_dev;
	struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
	struct rbd_obj_request *obj_request;
1751
	struct rbd_obj_request *next_obj_request;
A
Alex Elder 已提交
1752

A
Alex Elder 已提交
1753
	dout("%s: img %p\n", __func__, img_request);
1754
	for_each_obj_request_safe(img_request, obj_request, next_obj_request) {
A
Alex Elder 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
		int ret;

		obj_request->callback = rbd_img_obj_callback;
		ret = rbd_obj_request_submit(osdc, obj_request);
		if (ret)
			return ret;
		/*
		 * The image request has its own reference to each
		 * of its object requests, so we can safely drop the
		 * initial one here.
		 */
		rbd_obj_request_put(obj_request);
	}

	return 0;
}

A
Alex Elder 已提交
1772
static int rbd_obj_notify_ack(struct rbd_device *rbd_dev,
A
Alex Elder 已提交
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
				   u64 ver, u64 notify_id)
{
	struct rbd_obj_request *obj_request;
	struct ceph_osd_req_op *op;
	struct ceph_osd_client *osdc;
	int ret;

	obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
							OBJ_REQUEST_NODATA);
	if (!obj_request)
		return -ENOMEM;

	ret = -ENOMEM;
	op = rbd_osd_req_op_create(CEPH_OSD_OP_NOTIFY_ACK, notify_id, ver);
	if (!op)
		goto out;
	obj_request->osd_req = rbd_osd_req_create(rbd_dev, false,
						obj_request, op);
	rbd_osd_req_op_destroy(op);
	if (!obj_request->osd_req)
		goto out;

	osdc = &rbd_dev->rbd_client->client->osdc;
A
Alex Elder 已提交
1796
	obj_request->callback = rbd_obj_request_put;
A
Alex Elder 已提交
1797 1798
	ret = rbd_obj_request_submit(osdc, obj_request);
out:
A
Alex Elder 已提交
1799 1800
	if (ret)
		rbd_obj_request_put(obj_request);
A
Alex Elder 已提交
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813

	return ret;
}

static void rbd_watch_cb(u64 ver, u64 notify_id, u8 opcode, void *data)
{
	struct rbd_device *rbd_dev = (struct rbd_device *)data;
	u64 hver;
	int rc;

	if (!rbd_dev)
		return;

A
Alex Elder 已提交
1814
	dout("%s: \"%s\" notify_id %llu opcode %u\n", __func__,
A
Alex Elder 已提交
1815 1816 1817 1818 1819 1820 1821
		rbd_dev->header_name, (unsigned long long) notify_id,
		(unsigned int) opcode);
	rc = rbd_dev_refresh(rbd_dev, &hver);
	if (rc)
		rbd_warn(rbd_dev, "got notification but failed to "
			   " update snaps: %d\n", rc);

A
Alex Elder 已提交
1822
	rbd_obj_notify_ack(rbd_dev, hver, notify_id);
A
Alex Elder 已提交
1823 1824
}

1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839
/*
 * Request sync osd watch/unwatch.  The value of "start" determines
 * whether a watch request is being initiated or torn down.
 */
static int rbd_dev_header_watch_sync(struct rbd_device *rbd_dev, int start)
{
	struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
	struct rbd_obj_request *obj_request;
	struct ceph_osd_req_op *op;
	int ret;

	rbd_assert(start ^ !!rbd_dev->watch_event);
	rbd_assert(start ^ !!rbd_dev->watch_request);

	if (start) {
1840
		ret = ceph_osdc_create_event(osdc, rbd_watch_cb, rbd_dev,
1841 1842 1843
						&rbd_dev->watch_event);
		if (ret < 0)
			return ret;
1844
		rbd_assert(rbd_dev->watch_event != NULL);
1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863
	}

	ret = -ENOMEM;
	obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
							OBJ_REQUEST_NODATA);
	if (!obj_request)
		goto out_cancel;

	op = rbd_osd_req_op_create(CEPH_OSD_OP_WATCH,
				rbd_dev->watch_event->cookie,
				rbd_dev->header.obj_version, start);
	if (!op)
		goto out_cancel;
	obj_request->osd_req = rbd_osd_req_create(rbd_dev, true,
							obj_request, op);
	rbd_osd_req_op_destroy(op);
	if (!obj_request->osd_req)
		goto out_cancel;

1864
	if (start)
1865
		ceph_osdc_set_request_linger(osdc, obj_request->osd_req);
1866
	else
1867
		ceph_osdc_unregister_linger_request(osdc,
1868
					rbd_dev->watch_request->osd_req);
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878
	ret = rbd_obj_request_submit(osdc, obj_request);
	if (ret)
		goto out_cancel;
	ret = rbd_obj_request_wait(obj_request);
	if (ret)
		goto out_cancel;
	ret = obj_request->result;
	if (ret)
		goto out_cancel;

1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896
	/*
	 * A watch request is set to linger, so the underlying osd
	 * request won't go away until we unregister it.  We retain
	 * a pointer to the object request during that time (in
	 * rbd_dev->watch_request), so we'll keep a reference to
	 * it.  We'll drop that reference (below) after we've
	 * unregistered it.
	 */
	if (start) {
		rbd_dev->watch_request = obj_request;

		return 0;
	}

	/* We have successfully torn down the watch request */

	rbd_obj_request_put(rbd_dev->watch_request);
	rbd_dev->watch_request = NULL;
1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
out_cancel:
	/* Cancel the event if we're tearing down, or on error */
	ceph_osdc_cancel_event(rbd_dev->watch_event);
	rbd_dev->watch_event = NULL;
	if (obj_request)
		rbd_obj_request_put(obj_request);

	return ret;
}

1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969
/*
 * Synchronous osd object method call
 */
static int rbd_obj_method_sync(struct rbd_device *rbd_dev,
			     const char *object_name,
			     const char *class_name,
			     const char *method_name,
			     const char *outbound,
			     size_t outbound_size,
			     char *inbound,
			     size_t inbound_size,
			     u64 *version)
{
	struct rbd_obj_request *obj_request;
	struct ceph_osd_client *osdc;
	struct ceph_osd_req_op *op;
	struct page **pages;
	u32 page_count;
	int ret;

	/*
	 * Method calls are ultimately read operations but they
	 * don't involve object data (so no offset or length).
	 * The result should placed into the inbound buffer
	 * provided.  They also supply outbound data--parameters for
	 * the object method.  Currently if this is present it will
	 * be a snapshot id.
	 */
	page_count = (u32) calc_pages_for(0, inbound_size);
	pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
	if (IS_ERR(pages))
		return PTR_ERR(pages);

	ret = -ENOMEM;
	obj_request = rbd_obj_request_create(object_name, 0, 0,
							OBJ_REQUEST_PAGES);
	if (!obj_request)
		goto out;

	obj_request->pages = pages;
	obj_request->page_count = page_count;

	op = rbd_osd_req_op_create(CEPH_OSD_OP_CALL, class_name,
					method_name, outbound, outbound_size);
	if (!op)
		goto out;
	obj_request->osd_req = rbd_osd_req_create(rbd_dev, false,
						obj_request, op);
	rbd_osd_req_op_destroy(op);
	if (!obj_request->osd_req)
		goto out;

	osdc = &rbd_dev->rbd_client->client->osdc;
	ret = rbd_obj_request_submit(osdc, obj_request);
	if (ret)
		goto out;
	ret = rbd_obj_request_wait(obj_request);
	if (ret)
		goto out;

	ret = obj_request->result;
	if (ret < 0)
		goto out;
1970
	ret = 0;
1971
	ceph_copy_from_page_vector(pages, inbound, 0, obj_request->xferred);
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
	if (version)
		*version = obj_request->version;
out:
	if (obj_request)
		rbd_obj_request_put(obj_request);
	else
		ceph_release_page_vector(pages, page_count);

	return ret;
}

A
Alex Elder 已提交
1983
static void rbd_request_fn(struct request_queue *q)
A
Alex Elder 已提交
1984
		__releases(q->queue_lock) __acquires(q->queue_lock)
A
Alex Elder 已提交
1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
{
	struct rbd_device *rbd_dev = q->queuedata;
	bool read_only = rbd_dev->mapping.read_only;
	struct request *rq;
	int result;

	while ((rq = blk_fetch_request(q))) {
		bool write_request = rq_data_dir(rq) == WRITE;
		struct rbd_img_request *img_request;
		u64 offset;
		u64 length;

		/* Ignore any non-FS requests that filter through. */

		if (rq->cmd_type != REQ_TYPE_FS) {
A
Alex Elder 已提交
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012
			dout("%s: non-fs request type %d\n", __func__,
				(int) rq->cmd_type);
			__blk_end_request_all(rq, 0);
			continue;
		}

		/* Ignore/skip any zero-length requests */

		offset = (u64) blk_rq_pos(rq) << SECTOR_SHIFT;
		length = (u64) blk_rq_bytes(rq);

		if (!length) {
			dout("%s: zero-length request\n", __func__);
A
Alex Elder 已提交
2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027
			__blk_end_request_all(rq, 0);
			continue;
		}

		spin_unlock_irq(q->queue_lock);

		/* Disallow writes to a read-only device */

		if (write_request) {
			result = -EROFS;
			if (read_only)
				goto end_request;
			rbd_assert(rbd_dev->spec->snap_id == CEPH_NOSNAP);
		}

2028 2029 2030 2031 2032 2033 2034 2035
		/*
		 * Quit early if the mapped snapshot no longer
		 * exists.  It's still possible the snapshot will
		 * have disappeared by the time our request arrives
		 * at the osd, but there's no sense in sending it if
		 * we already know.
		 */
		if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags)) {
A
Alex Elder 已提交
2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068
			dout("request for non-existent snapshot");
			rbd_assert(rbd_dev->spec->snap_id != CEPH_NOSNAP);
			result = -ENXIO;
			goto end_request;
		}

		result = -EINVAL;
		if (WARN_ON(offset && length > U64_MAX - offset + 1))
			goto end_request;	/* Shouldn't happen */

		result = -ENOMEM;
		img_request = rbd_img_request_create(rbd_dev, offset, length,
							write_request);
		if (!img_request)
			goto end_request;

		img_request->rq = rq;

		result = rbd_img_request_fill_bio(img_request, rq->bio);
		if (!result)
			result = rbd_img_request_submit(img_request);
		if (result)
			rbd_img_request_put(img_request);
end_request:
		spin_lock_irq(q->queue_lock);
		if (result < 0) {
			rbd_warn(rbd_dev, "obj_request %s result %d\n",
				write_request ? "write" : "read", result);
			__blk_end_request_all(rq, result);
		}
	}
}

2069 2070 2071
/*
 * a queue callback. Makes sure that we don't create a bio that spans across
 * multiple osd objects. One exception would be with a single page bios,
A
Alex Elder 已提交
2072
 * which we handle later at bio_chain_clone_range()
2073 2074 2075 2076 2077
 */
static int rbd_merge_bvec(struct request_queue *q, struct bvec_merge_data *bmd,
			  struct bio_vec *bvec)
{
	struct rbd_device *rbd_dev = q->queuedata;
A
Alex Elder 已提交
2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
	sector_t sector_offset;
	sector_t sectors_per_obj;
	sector_t obj_sector_offset;
	int ret;

	/*
	 * Find how far into its rbd object the partition-relative
	 * bio start sector is to offset relative to the enclosing
	 * device.
	 */
	sector_offset = get_start_sect(bmd->bi_bdev) + bmd->bi_sector;
	sectors_per_obj = 1 << (rbd_dev->header.obj_order - SECTOR_SHIFT);
	obj_sector_offset = sector_offset & (sectors_per_obj - 1);

	/*
	 * Compute the number of bytes from that offset to the end
	 * of the object.  Account for what's already used by the bio.
	 */
	ret = (int) (sectors_per_obj - obj_sector_offset) << SECTOR_SHIFT;
	if (ret > bmd->bi_size)
		ret -= bmd->bi_size;
	else
		ret = 0;

	/*
	 * Don't send back more than was asked for.  And if the bio
	 * was empty, let the whole thing through because:  "Note
	 * that a block device *must* allow a single page to be
	 * added to an empty bio."
	 */
	rbd_assert(bvec->bv_len <= PAGE_SIZE);
	if (ret > (int) bvec->bv_len || !bmd->bi_size)
		ret = (int) bvec->bv_len;

	return ret;
2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
}

static void rbd_free_disk(struct rbd_device *rbd_dev)
{
	struct gendisk *disk = rbd_dev->disk;

	if (!disk)
		return;

	if (disk->flags & GENHD_FL_UP)
		del_gendisk(disk);
	if (disk->queue)
		blk_cleanup_queue(disk->queue);
	put_disk(disk);
}

2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139
static int rbd_obj_read_sync(struct rbd_device *rbd_dev,
				const char *object_name,
				u64 offset, u64 length,
				char *buf, u64 *version)

{
	struct ceph_osd_req_op *op;
	struct rbd_obj_request *obj_request;
	struct ceph_osd_client *osdc;
	struct page **pages = NULL;
	u32 page_count;
2140
	size_t size;
2141 2142 2143 2144 2145 2146 2147 2148 2149
	int ret;

	page_count = (u32) calc_pages_for(offset, length);
	pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
	if (IS_ERR(pages))
		ret = PTR_ERR(pages);

	ret = -ENOMEM;
	obj_request = rbd_obj_request_create(object_name, offset, length,
2150
							OBJ_REQUEST_PAGES);
2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
	if (!obj_request)
		goto out;

	obj_request->pages = pages;
	obj_request->page_count = page_count;

	op = rbd_osd_req_op_create(CEPH_OSD_OP_READ, offset, length);
	if (!op)
		goto out;
	obj_request->osd_req = rbd_osd_req_create(rbd_dev, false,
						obj_request, op);
	rbd_osd_req_op_destroy(op);
	if (!obj_request->osd_req)
		goto out;

	osdc = &rbd_dev->rbd_client->client->osdc;
	ret = rbd_obj_request_submit(osdc, obj_request);
	if (ret)
		goto out;
	ret = rbd_obj_request_wait(obj_request);
	if (ret)
		goto out;

	ret = obj_request->result;
	if (ret < 0)
		goto out;
2177 2178 2179

	rbd_assert(obj_request->xferred <= (u64) SIZE_MAX);
	size = (size_t) obj_request->xferred;
2180
	ceph_copy_from_page_vector(pages, buf, 0, size);
2181 2182
	rbd_assert(size <= (size_t) INT_MAX);
	ret = (int) size;
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
	if (version)
		*version = obj_request->version;
out:
	if (obj_request)
		rbd_obj_request_put(obj_request);
	else
		ceph_release_page_vector(pages, page_count);

	return ret;
}

2194
/*
2195 2196 2197 2198 2199 2200 2201 2202
 * Read the complete header for the given rbd device.
 *
 * Returns a pointer to a dynamically-allocated buffer containing
 * the complete and validated header.  Caller can pass the address
 * of a variable that will be filled in with the version of the
 * header object at the time it was read.
 *
 * Returns a pointer-coded errno if a failure occurs.
2203
 */
2204 2205
static struct rbd_image_header_ondisk *
rbd_dev_v1_header_read(struct rbd_device *rbd_dev, u64 *version)
2206
{
2207
	struct rbd_image_header_ondisk *ondisk = NULL;
2208
	u32 snap_count = 0;
2209 2210 2211
	u64 names_size = 0;
	u32 want_count;
	int ret;
2212

A
Alex Elder 已提交
2213
	/*
2214 2215 2216 2217 2218
	 * The complete header will include an array of its 64-bit
	 * snapshot ids, followed by the names of those snapshots as
	 * a contiguous block of NUL-terminated strings.  Note that
	 * the number of snapshots could change by the time we read
	 * it in, in which case we re-read it.
A
Alex Elder 已提交
2219
	 */
2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231
	do {
		size_t size;

		kfree(ondisk);

		size = sizeof (*ondisk);
		size += snap_count * sizeof (struct rbd_image_snap_ondisk);
		size += names_size;
		ondisk = kmalloc(size, GFP_KERNEL);
		if (!ondisk)
			return ERR_PTR(-ENOMEM);

2232
		ret = rbd_obj_read_sync(rbd_dev, rbd_dev->header_name,
2233 2234 2235 2236 2237 2238
				       0, size,
				       (char *) ondisk, version);
		if (ret < 0)
			goto out_err;
		if (WARN_ON((size_t) ret < size)) {
			ret = -ENXIO;
A
Alex Elder 已提交
2239 2240
			rbd_warn(rbd_dev, "short header read (want %zd got %d)",
				size, ret);
2241 2242 2243 2244
			goto out_err;
		}
		if (!rbd_dev_ondisk_valid(ondisk)) {
			ret = -ENXIO;
A
Alex Elder 已提交
2245
			rbd_warn(rbd_dev, "invalid header");
2246
			goto out_err;
2247
		}
2248

2249 2250 2251 2252
		names_size = le64_to_cpu(ondisk->snap_names_len);
		want_count = snap_count;
		snap_count = le32_to_cpu(ondisk->snap_count);
	} while (snap_count != want_count);
A
Alex Elder 已提交
2253

2254
	return ondisk;
A
Alex Elder 已提交
2255

2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
out_err:
	kfree(ondisk);

	return ERR_PTR(ret);
}

/*
 * reload the ondisk the header
 */
static int rbd_read_header(struct rbd_device *rbd_dev,
			   struct rbd_image_header *header)
{
	struct rbd_image_header_ondisk *ondisk;
	u64 ver = 0;
	int ret;
2271

2272 2273 2274 2275 2276 2277 2278 2279 2280
	ondisk = rbd_dev_v1_header_read(rbd_dev, &ver);
	if (IS_ERR(ondisk))
		return PTR_ERR(ondisk);
	ret = rbd_header_from_disk(header, ondisk);
	if (ret >= 0)
		header->obj_version = ver;
	kfree(ondisk);

	return ret;
2281 2282
}

2283
static void rbd_remove_all_snaps(struct rbd_device *rbd_dev)
2284 2285
{
	struct rbd_snap *snap;
2286
	struct rbd_snap *next;
2287

2288
	list_for_each_entry_safe(snap, next, &rbd_dev->snaps, node)
2289
		rbd_remove_snap_dev(snap);
2290 2291
}

A
Alex Elder 已提交
2292 2293 2294 2295
static void rbd_update_mapping_size(struct rbd_device *rbd_dev)
{
	sector_t size;

2296
	if (rbd_dev->spec->snap_id != CEPH_NOSNAP)
A
Alex Elder 已提交
2297 2298 2299 2300 2301 2302 2303 2304
		return;

	size = (sector_t) rbd_dev->header.image_size / SECTOR_SIZE;
	dout("setting size to %llu sectors", (unsigned long long) size);
	rbd_dev->mapping.size = (u64) size;
	set_capacity(rbd_dev->disk, size);
}

2305 2306 2307
/*
 * only read the first part of the ondisk header, without the snaps info
 */
A
Alex Elder 已提交
2308
static int rbd_dev_v1_refresh(struct rbd_device *rbd_dev, u64 *hver)
2309 2310 2311 2312 2313 2314 2315 2316
{
	int ret;
	struct rbd_image_header h;

	ret = rbd_read_header(rbd_dev, &h);
	if (ret < 0)
		return ret;

2317 2318
	down_write(&rbd_dev->header_rwsem);

A
Alex Elder 已提交
2319 2320 2321
	/* Update image size, and check for resize of mapped image */
	rbd_dev->header.image_size = h.image_size;
	rbd_update_mapping_size(rbd_dev);
2322

2323
	/* rbd_dev->header.object_prefix shouldn't change */
2324
	kfree(rbd_dev->header.snap_sizes);
2325
	kfree(rbd_dev->header.snap_names);
2326 2327
	/* osd requests may still refer to snapc */
	ceph_put_snap_context(rbd_dev->header.snapc);
2328

2329 2330
	if (hver)
		*hver = h.obj_version;
2331
	rbd_dev->header.obj_version = h.obj_version;
2332
	rbd_dev->header.image_size = h.image_size;
2333 2334 2335
	rbd_dev->header.snapc = h.snapc;
	rbd_dev->header.snap_names = h.snap_names;
	rbd_dev->header.snap_sizes = h.snap_sizes;
2336 2337 2338 2339
	/* Free the extra copy of the object prefix */
	WARN_ON(strcmp(rbd_dev->header.object_prefix, h.object_prefix));
	kfree(h.object_prefix);

2340 2341 2342
	ret = rbd_dev_snaps_update(rbd_dev);
	if (!ret)
		ret = rbd_dev_snaps_register(rbd_dev);
2343

2344
	up_write(&rbd_dev->header_rwsem);
2345

2346
	return ret;
2347 2348
}

A
Alex Elder 已提交
2349
static int rbd_dev_refresh(struct rbd_device *rbd_dev, u64 *hver)
A
Alex Elder 已提交
2350 2351 2352
{
	int ret;

A
Alex Elder 已提交
2353
	rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
A
Alex Elder 已提交
2354
	mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
A
Alex Elder 已提交
2355 2356 2357 2358
	if (rbd_dev->image_format == 1)
		ret = rbd_dev_v1_refresh(rbd_dev, hver);
	else
		ret = rbd_dev_v2_refresh(rbd_dev, hver);
A
Alex Elder 已提交
2359 2360 2361 2362 2363
	mutex_unlock(&ctl_mutex);

	return ret;
}

2364 2365 2366 2367
static int rbd_init_disk(struct rbd_device *rbd_dev)
{
	struct gendisk *disk;
	struct request_queue *q;
A
Alex Elder 已提交
2368
	u64 segment_size;
2369 2370 2371 2372

	/* create gendisk info */
	disk = alloc_disk(RBD_MINORS_PER_MAJOR);
	if (!disk)
A
Alex Elder 已提交
2373
		return -ENOMEM;
2374

A
Alex Elder 已提交
2375
	snprintf(disk->disk_name, sizeof(disk->disk_name), RBD_DRV_NAME "%d",
A
Alex Elder 已提交
2376
		 rbd_dev->dev_id);
2377 2378 2379 2380 2381
	disk->major = rbd_dev->major;
	disk->first_minor = 0;
	disk->fops = &rbd_bd_ops;
	disk->private_data = rbd_dev;

A
Alex Elder 已提交
2382
	q = blk_init_queue(rbd_request_fn, &rbd_dev->lock);
2383 2384
	if (!q)
		goto out_disk;
2385

A
Alex Elder 已提交
2386 2387 2388
	/* We use the default size, but let's be explicit about it. */
	blk_queue_physical_block_size(q, SECTOR_SIZE);

2389
	/* set io sizes to object size */
A
Alex Elder 已提交
2390 2391 2392 2393 2394
	segment_size = rbd_obj_bytes(&rbd_dev->header);
	blk_queue_max_hw_sectors(q, segment_size / SECTOR_SIZE);
	blk_queue_max_segment_size(q, segment_size);
	blk_queue_io_min(q, segment_size);
	blk_queue_io_opt(q, segment_size);
2395

2396 2397 2398 2399 2400 2401 2402
	blk_queue_merge_bvec(q, rbd_merge_bvec);
	disk->queue = q;

	q->queuedata = rbd_dev;

	rbd_dev->disk = disk;

2403 2404
	set_capacity(rbd_dev->disk, rbd_dev->mapping.size / SECTOR_SIZE);

2405 2406 2407
	return 0;
out_disk:
	put_disk(disk);
A
Alex Elder 已提交
2408 2409

	return -ENOMEM;
2410 2411
}

2412 2413 2414 2415
/*
  sysfs
*/

A
Alex Elder 已提交
2416 2417 2418 2419 2420
static struct rbd_device *dev_to_rbd_dev(struct device *dev)
{
	return container_of(dev, struct rbd_device, dev);
}

2421 2422 2423
static ssize_t rbd_size_show(struct device *dev,
			     struct device_attribute *attr, char *buf)
{
A
Alex Elder 已提交
2424
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2425 2426 2427 2428 2429
	sector_t size;

	down_read(&rbd_dev->header_rwsem);
	size = get_capacity(rbd_dev->disk);
	up_read(&rbd_dev->header_rwsem);
2430

2431
	return sprintf(buf, "%llu\n", (unsigned long long) size * SECTOR_SIZE);
2432 2433
}

A
Alex Elder 已提交
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446
/*
 * Note this shows the features for whatever's mapped, which is not
 * necessarily the base image.
 */
static ssize_t rbd_features_show(struct device *dev,
			     struct device_attribute *attr, char *buf)
{
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);

	return sprintf(buf, "0x%016llx\n",
			(unsigned long long) rbd_dev->mapping.features);
}

2447 2448 2449
static ssize_t rbd_major_show(struct device *dev,
			      struct device_attribute *attr, char *buf)
{
A
Alex Elder 已提交
2450
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2451

2452 2453 2454 2455 2456
	return sprintf(buf, "%d\n", rbd_dev->major);
}

static ssize_t rbd_client_id_show(struct device *dev,
				  struct device_attribute *attr, char *buf)
2457
{
A
Alex Elder 已提交
2458
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2459

2460 2461
	return sprintf(buf, "client%lld\n",
			ceph_client_id(rbd_dev->rbd_client->client));
2462 2463
}

2464 2465
static ssize_t rbd_pool_show(struct device *dev,
			     struct device_attribute *attr, char *buf)
2466
{
A
Alex Elder 已提交
2467
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2468

2469
	return sprintf(buf, "%s\n", rbd_dev->spec->pool_name);
2470 2471
}

2472 2473 2474 2475 2476
static ssize_t rbd_pool_id_show(struct device *dev,
			     struct device_attribute *attr, char *buf)
{
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);

2477 2478
	return sprintf(buf, "%llu\n",
		(unsigned long long) rbd_dev->spec->pool_id);
2479 2480
}

2481 2482 2483
static ssize_t rbd_name_show(struct device *dev,
			     struct device_attribute *attr, char *buf)
{
A
Alex Elder 已提交
2484
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2485

A
Alex Elder 已提交
2486 2487 2488 2489
	if (rbd_dev->spec->image_name)
		return sprintf(buf, "%s\n", rbd_dev->spec->image_name);

	return sprintf(buf, "(unknown)\n");
2490 2491
}

A
Alex Elder 已提交
2492 2493 2494 2495 2496
static ssize_t rbd_image_id_show(struct device *dev,
			     struct device_attribute *attr, char *buf)
{
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);

2497
	return sprintf(buf, "%s\n", rbd_dev->spec->image_id);
A
Alex Elder 已提交
2498 2499
}

A
Alex Elder 已提交
2500 2501 2502 2503
/*
 * Shows the name of the currently-mapped snapshot (or
 * RBD_SNAP_HEAD_NAME for the base image).
 */
2504 2505 2506 2507
static ssize_t rbd_snap_show(struct device *dev,
			     struct device_attribute *attr,
			     char *buf)
{
A
Alex Elder 已提交
2508
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2509

2510
	return sprintf(buf, "%s\n", rbd_dev->spec->snap_name);
2511 2512
}

2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555
/*
 * For an rbd v2 image, shows the pool id, image id, and snapshot id
 * for the parent image.  If there is no parent, simply shows
 * "(no parent image)".
 */
static ssize_t rbd_parent_show(struct device *dev,
			     struct device_attribute *attr,
			     char *buf)
{
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
	struct rbd_spec *spec = rbd_dev->parent_spec;
	int count;
	char *bufp = buf;

	if (!spec)
		return sprintf(buf, "(no parent image)\n");

	count = sprintf(bufp, "pool_id %llu\npool_name %s\n",
			(unsigned long long) spec->pool_id, spec->pool_name);
	if (count < 0)
		return count;
	bufp += count;

	count = sprintf(bufp, "image_id %s\nimage_name %s\n", spec->image_id,
			spec->image_name ? spec->image_name : "(unknown)");
	if (count < 0)
		return count;
	bufp += count;

	count = sprintf(bufp, "snap_id %llu\nsnap_name %s\n",
			(unsigned long long) spec->snap_id, spec->snap_name);
	if (count < 0)
		return count;
	bufp += count;

	count = sprintf(bufp, "overlap %llu\n", rbd_dev->parent_overlap);
	if (count < 0)
		return count;
	bufp += count;

	return (ssize_t) (bufp - buf);
}

2556 2557 2558 2559 2560
static ssize_t rbd_image_refresh(struct device *dev,
				 struct device_attribute *attr,
				 const char *buf,
				 size_t size)
{
A
Alex Elder 已提交
2561
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
2562
	int ret;
2563

A
Alex Elder 已提交
2564
	ret = rbd_dev_refresh(rbd_dev, NULL);
2565 2566

	return ret < 0 ? ret : size;
2567
}
2568

2569
static DEVICE_ATTR(size, S_IRUGO, rbd_size_show, NULL);
A
Alex Elder 已提交
2570
static DEVICE_ATTR(features, S_IRUGO, rbd_features_show, NULL);
2571 2572 2573
static DEVICE_ATTR(major, S_IRUGO, rbd_major_show, NULL);
static DEVICE_ATTR(client_id, S_IRUGO, rbd_client_id_show, NULL);
static DEVICE_ATTR(pool, S_IRUGO, rbd_pool_show, NULL);
2574
static DEVICE_ATTR(pool_id, S_IRUGO, rbd_pool_id_show, NULL);
2575
static DEVICE_ATTR(name, S_IRUGO, rbd_name_show, NULL);
A
Alex Elder 已提交
2576
static DEVICE_ATTR(image_id, S_IRUGO, rbd_image_id_show, NULL);
2577 2578
static DEVICE_ATTR(refresh, S_IWUSR, NULL, rbd_image_refresh);
static DEVICE_ATTR(current_snap, S_IRUGO, rbd_snap_show, NULL);
2579
static DEVICE_ATTR(parent, S_IRUGO, rbd_parent_show, NULL);
2580 2581 2582

static struct attribute *rbd_attrs[] = {
	&dev_attr_size.attr,
A
Alex Elder 已提交
2583
	&dev_attr_features.attr,
2584 2585 2586
	&dev_attr_major.attr,
	&dev_attr_client_id.attr,
	&dev_attr_pool.attr,
2587
	&dev_attr_pool_id.attr,
2588
	&dev_attr_name.attr,
A
Alex Elder 已提交
2589
	&dev_attr_image_id.attr,
2590
	&dev_attr_current_snap.attr,
2591
	&dev_attr_parent.attr,
2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625
	&dev_attr_refresh.attr,
	NULL
};

static struct attribute_group rbd_attr_group = {
	.attrs = rbd_attrs,
};

static const struct attribute_group *rbd_attr_groups[] = {
	&rbd_attr_group,
	NULL
};

static void rbd_sysfs_dev_release(struct device *dev)
{
}

static struct device_type rbd_device_type = {
	.name		= "rbd",
	.groups		= rbd_attr_groups,
	.release	= rbd_sysfs_dev_release,
};


/*
  sysfs - snapshots
*/

static ssize_t rbd_snap_size_show(struct device *dev,
				  struct device_attribute *attr,
				  char *buf)
{
	struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);

J
Josh Durgin 已提交
2626
	return sprintf(buf, "%llu\n", (unsigned long long)snap->size);
2627 2628 2629 2630 2631 2632 2633 2634
}

static ssize_t rbd_snap_id_show(struct device *dev,
				struct device_attribute *attr,
				char *buf)
{
	struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);

J
Josh Durgin 已提交
2635
	return sprintf(buf, "%llu\n", (unsigned long long)snap->id);
2636 2637
}

A
Alex Elder 已提交
2638 2639 2640 2641 2642 2643 2644 2645 2646 2647
static ssize_t rbd_snap_features_show(struct device *dev,
				struct device_attribute *attr,
				char *buf)
{
	struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);

	return sprintf(buf, "0x%016llx\n",
			(unsigned long long) snap->features);
}

2648 2649
static DEVICE_ATTR(snap_size, S_IRUGO, rbd_snap_size_show, NULL);
static DEVICE_ATTR(snap_id, S_IRUGO, rbd_snap_id_show, NULL);
A
Alex Elder 已提交
2650
static DEVICE_ATTR(snap_features, S_IRUGO, rbd_snap_features_show, NULL);
2651 2652 2653 2654

static struct attribute *rbd_snap_attrs[] = {
	&dev_attr_snap_size.attr,
	&dev_attr_snap_id.attr,
A
Alex Elder 已提交
2655
	&dev_attr_snap_features.attr,
2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679
	NULL,
};

static struct attribute_group rbd_snap_attr_group = {
	.attrs = rbd_snap_attrs,
};

static void rbd_snap_dev_release(struct device *dev)
{
	struct rbd_snap *snap = container_of(dev, struct rbd_snap, dev);
	kfree(snap->name);
	kfree(snap);
}

static const struct attribute_group *rbd_snap_attr_groups[] = {
	&rbd_snap_attr_group,
	NULL
};

static struct device_type rbd_snap_device_type = {
	.groups		= rbd_snap_attr_groups,
	.release	= rbd_snap_dev_release,
};

2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718
static struct rbd_spec *rbd_spec_get(struct rbd_spec *spec)
{
	kref_get(&spec->kref);

	return spec;
}

static void rbd_spec_free(struct kref *kref);
static void rbd_spec_put(struct rbd_spec *spec)
{
	if (spec)
		kref_put(&spec->kref, rbd_spec_free);
}

static struct rbd_spec *rbd_spec_alloc(void)
{
	struct rbd_spec *spec;

	spec = kzalloc(sizeof (*spec), GFP_KERNEL);
	if (!spec)
		return NULL;
	kref_init(&spec->kref);

	rbd_spec_put(rbd_spec_get(spec));	/* TEMPORARY */

	return spec;
}

static void rbd_spec_free(struct kref *kref)
{
	struct rbd_spec *spec = container_of(kref, struct rbd_spec, kref);

	kfree(spec->pool_name);
	kfree(spec->image_id);
	kfree(spec->image_name);
	kfree(spec->snap_name);
	kfree(spec);
}

A
Alex Elder 已提交
2719
static struct rbd_device *rbd_dev_create(struct rbd_client *rbdc,
2720 2721 2722 2723 2724 2725 2726 2727 2728
				struct rbd_spec *spec)
{
	struct rbd_device *rbd_dev;

	rbd_dev = kzalloc(sizeof (*rbd_dev), GFP_KERNEL);
	if (!rbd_dev)
		return NULL;

	spin_lock_init(&rbd_dev->lock);
2729
	rbd_dev->flags = 0;
2730 2731 2732 2733 2734 2735 2736
	INIT_LIST_HEAD(&rbd_dev->node);
	INIT_LIST_HEAD(&rbd_dev->snaps);
	init_rwsem(&rbd_dev->header_rwsem);

	rbd_dev->spec = spec;
	rbd_dev->rbd_client = rbdc;

2737 2738 2739 2740 2741 2742 2743
	/* Initialize the layout used for all rbd requests */

	rbd_dev->layout.fl_stripe_unit = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
	rbd_dev->layout.fl_stripe_count = cpu_to_le32(1);
	rbd_dev->layout.fl_object_size = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
	rbd_dev->layout.fl_pg_pool = cpu_to_le32((u32) spec->pool_id);

2744 2745 2746 2747 2748
	return rbd_dev;
}

static void rbd_dev_destroy(struct rbd_device *rbd_dev)
{
2749
	rbd_spec_put(rbd_dev->parent_spec);
2750 2751 2752 2753 2754 2755
	kfree(rbd_dev->header_name);
	rbd_put_client(rbd_dev->rbd_client);
	rbd_spec_put(rbd_dev->spec);
	kfree(rbd_dev);
}

2756 2757 2758 2759 2760 2761 2762 2763 2764 2765
static bool rbd_snap_registered(struct rbd_snap *snap)
{
	bool ret = snap->dev.type == &rbd_snap_device_type;
	bool reg = device_is_registered(&snap->dev);

	rbd_assert(!ret ^ reg);

	return ret;
}

2766
static void rbd_remove_snap_dev(struct rbd_snap *snap)
2767 2768
{
	list_del(&snap->node);
2769 2770
	if (device_is_registered(&snap->dev))
		device_unregister(&snap->dev);
2771 2772
}

2773
static int rbd_register_snap_dev(struct rbd_snap *snap,
2774 2775 2776 2777 2778 2779 2780 2781
				  struct device *parent)
{
	struct device *dev = &snap->dev;
	int ret;

	dev->type = &rbd_snap_device_type;
	dev->parent = parent;
	dev->release = rbd_snap_dev_release;
2782
	dev_set_name(dev, "%s%s", RBD_SNAP_DEV_NAME_PREFIX, snap->name);
2783 2784
	dout("%s: registering device for snapshot %s\n", __func__, snap->name);

2785 2786 2787 2788 2789
	ret = device_register(dev);

	return ret;
}

2790
static struct rbd_snap *__rbd_add_snap_dev(struct rbd_device *rbd_dev,
2791
						const char *snap_name,
A
Alex Elder 已提交
2792 2793
						u64 snap_id, u64 snap_size,
						u64 snap_features)
2794
{
2795
	struct rbd_snap *snap;
2796
	int ret;
2797 2798

	snap = kzalloc(sizeof (*snap), GFP_KERNEL);
2799
	if (!snap)
2800 2801 2802
		return ERR_PTR(-ENOMEM);

	ret = -ENOMEM;
2803
	snap->name = kstrdup(snap_name, GFP_KERNEL);
2804 2805 2806
	if (!snap->name)
		goto err;

2807 2808
	snap->id = snap_id;
	snap->size = snap_size;
A
Alex Elder 已提交
2809
	snap->features = snap_features;
2810 2811 2812

	return snap;

2813 2814 2815
err:
	kfree(snap->name);
	kfree(snap);
2816 2817

	return ERR_PTR(ret);
2818 2819
}

2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838
static char *rbd_dev_v1_snap_info(struct rbd_device *rbd_dev, u32 which,
		u64 *snap_size, u64 *snap_features)
{
	char *snap_name;

	rbd_assert(which < rbd_dev->header.snapc->num_snaps);

	*snap_size = rbd_dev->header.snap_sizes[which];
	*snap_features = 0;	/* No features for v1 */

	/* Skip over names until we find the one we are looking for */

	snap_name = rbd_dev->header.snap_names;
	while (which--)
		snap_name += strlen(snap_name) + 1;

	return snap_name;
}

2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853
/*
 * Get the size and object order for an image snapshot, or if
 * snap_id is CEPH_NOSNAP, gets this information for the base
 * image.
 */
static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
				u8 *order, u64 *snap_size)
{
	__le64 snapid = cpu_to_le64(snap_id);
	int ret;
	struct {
		u8 order;
		__le64 size;
	} __attribute__ ((packed)) size_buf = { 0 };

2854
	ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
2855 2856
				"rbd", "get_size",
				(char *) &snapid, sizeof (snapid),
2857
				(char *) &size_buf, sizeof (size_buf), NULL);
2858
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878
	if (ret < 0)
		return ret;

	*order = size_buf.order;
	*snap_size = le64_to_cpu(size_buf.size);

	dout("  snap_id 0x%016llx order = %u, snap_size = %llu\n",
		(unsigned long long) snap_id, (unsigned int) *order,
		(unsigned long long) *snap_size);

	return 0;
}

static int rbd_dev_v2_image_size(struct rbd_device *rbd_dev)
{
	return _rbd_dev_v2_snap_size(rbd_dev, CEPH_NOSNAP,
					&rbd_dev->header.obj_order,
					&rbd_dev->header.image_size);
}

2879 2880 2881 2882 2883 2884 2885 2886 2887 2888
static int rbd_dev_v2_object_prefix(struct rbd_device *rbd_dev)
{
	void *reply_buf;
	int ret;
	void *p;

	reply_buf = kzalloc(RBD_OBJ_PREFIX_LEN_MAX, GFP_KERNEL);
	if (!reply_buf)
		return -ENOMEM;

2889
	ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
2890 2891
				"rbd", "get_object_prefix",
				NULL, 0,
2892
				reply_buf, RBD_OBJ_PREFIX_LEN_MAX, NULL);
2893
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914
	if (ret < 0)
		goto out;

	p = reply_buf;
	rbd_dev->header.object_prefix = ceph_extract_encoded_string(&p,
						p + RBD_OBJ_PREFIX_LEN_MAX,
						NULL, GFP_NOIO);

	if (IS_ERR(rbd_dev->header.object_prefix)) {
		ret = PTR_ERR(rbd_dev->header.object_prefix);
		rbd_dev->header.object_prefix = NULL;
	} else {
		dout("  object_prefix = %s\n", rbd_dev->header.object_prefix);
	}

out:
	kfree(reply_buf);

	return ret;
}

2915 2916 2917 2918 2919 2920 2921 2922
static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
		u64 *snap_features)
{
	__le64 snapid = cpu_to_le64(snap_id);
	struct {
		__le64 features;
		__le64 incompat;
	} features_buf = { 0 };
A
Alex Elder 已提交
2923
	u64 incompat;
2924 2925
	int ret;

2926
	ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
2927 2928 2929
				"rbd", "get_features",
				(char *) &snapid, sizeof (snapid),
				(char *) &features_buf, sizeof (features_buf),
2930
				NULL);
2931
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
2932 2933
	if (ret < 0)
		return ret;
A
Alex Elder 已提交
2934 2935 2936

	incompat = le64_to_cpu(features_buf.incompat);
	if (incompat & ~RBD_FEATURES_ALL)
A
Alex Elder 已提交
2937
		return -ENXIO;
A
Alex Elder 已提交
2938

2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954
	*snap_features = le64_to_cpu(features_buf.features);

	dout("  snap_id 0x%016llx features = 0x%016llx incompat = 0x%016llx\n",
		(unsigned long long) snap_id,
		(unsigned long long) *snap_features,
		(unsigned long long) le64_to_cpu(features_buf.incompat));

	return 0;
}

static int rbd_dev_v2_features(struct rbd_device *rbd_dev)
{
	return _rbd_dev_v2_snap_features(rbd_dev, CEPH_NOSNAP,
						&rbd_dev->header.features);
}

2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev)
{
	struct rbd_spec *parent_spec;
	size_t size;
	void *reply_buf = NULL;
	__le64 snapid;
	void *p;
	void *end;
	char *image_id;
	u64 overlap;
	int ret;

	parent_spec = rbd_spec_alloc();
	if (!parent_spec)
		return -ENOMEM;

	size = sizeof (__le64) +				/* pool_id */
		sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX +	/* image_id */
		sizeof (__le64) +				/* snap_id */
		sizeof (__le64);				/* overlap */
	reply_buf = kmalloc(size, GFP_KERNEL);
	if (!reply_buf) {
		ret = -ENOMEM;
		goto out_err;
	}

	snapid = cpu_to_le64(CEPH_NOSNAP);
2982
	ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
2983 2984
				"rbd", "get_parent",
				(char *) &snapid, sizeof (snapid),
2985
				(char *) reply_buf, size, NULL);
2986
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
2987 2988 2989 2990 2991 2992 2993 2994 2995 2996
	if (ret < 0)
		goto out_err;

	ret = -ERANGE;
	p = reply_buf;
	end = (char *) reply_buf + size;
	ceph_decode_64_safe(&p, end, parent_spec->pool_id, out_err);
	if (parent_spec->pool_id == CEPH_NOPOOL)
		goto out;	/* No parent?  No problem. */

2997 2998 2999 3000 3001 3002
	/* The ceph file layout needs to fit pool id in 32 bits */

	ret = -EIO;
	if (WARN_ON(parent_spec->pool_id > (u64) U32_MAX))
		goto out;

A
Alex Elder 已提交
3003
	image_id = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023
	if (IS_ERR(image_id)) {
		ret = PTR_ERR(image_id);
		goto out_err;
	}
	parent_spec->image_id = image_id;
	ceph_decode_64_safe(&p, end, parent_spec->snap_id, out_err);
	ceph_decode_64_safe(&p, end, overlap, out_err);

	rbd_dev->parent_overlap = overlap;
	rbd_dev->parent_spec = parent_spec;
	parent_spec = NULL;	/* rbd_dev now owns this */
out:
	ret = 0;
out_err:
	kfree(reply_buf);
	rbd_spec_put(parent_spec);

	return ret;
}

3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037
static char *rbd_dev_image_name(struct rbd_device *rbd_dev)
{
	size_t image_id_size;
	char *image_id;
	void *p;
	void *end;
	size_t size;
	void *reply_buf = NULL;
	size_t len = 0;
	char *image_name = NULL;
	int ret;

	rbd_assert(!rbd_dev->spec->image_name);

A
Alex Elder 已提交
3038 3039
	len = strlen(rbd_dev->spec->image_id);
	image_id_size = sizeof (__le32) + len;
3040 3041 3042 3043 3044 3045
	image_id = kmalloc(image_id_size, GFP_KERNEL);
	if (!image_id)
		return NULL;

	p = image_id;
	end = (char *) image_id + image_id_size;
A
Alex Elder 已提交
3046
	ceph_encode_string(&p, end, rbd_dev->spec->image_id, (u32) len);
3047 3048 3049 3050 3051 3052

	size = sizeof (__le32) + RBD_IMAGE_NAME_LEN_MAX;
	reply_buf = kmalloc(size, GFP_KERNEL);
	if (!reply_buf)
		goto out;

3053
	ret = rbd_obj_method_sync(rbd_dev, RBD_DIRECTORY,
3054 3055
				"rbd", "dir_get_name",
				image_id, image_id_size,
3056
				(char *) reply_buf, size, NULL);
3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094
	if (ret < 0)
		goto out;
	p = reply_buf;
	end = (char *) reply_buf + size;
	image_name = ceph_extract_encoded_string(&p, end, &len, GFP_KERNEL);
	if (IS_ERR(image_name))
		image_name = NULL;
	else
		dout("%s: name is %s len is %zd\n", __func__, image_name, len);
out:
	kfree(reply_buf);
	kfree(image_id);

	return image_name;
}

/*
 * When a parent image gets probed, we only have the pool, image,
 * and snapshot ids but not the names of any of them.  This call
 * is made later to fill in those names.  It has to be done after
 * rbd_dev_snaps_update() has completed because some of the
 * information (in particular, snapshot name) is not available
 * until then.
 */
static int rbd_dev_probe_update_spec(struct rbd_device *rbd_dev)
{
	struct ceph_osd_client *osdc;
	const char *name;
	void *reply_buf = NULL;
	int ret;

	if (rbd_dev->spec->pool_name)
		return 0;	/* Already have the names */

	/* Look up the pool name */

	osdc = &rbd_dev->rbd_client->client->osdc;
	name = ceph_pg_pool_name_by_id(osdc->osdmap, rbd_dev->spec->pool_id);
3095 3096 3097 3098 3099
	if (!name) {
		rbd_warn(rbd_dev, "there is no pool with id %llu",
			rbd_dev->spec->pool_id);	/* Really a BUG() */
		return -EIO;
	}
3100 3101 3102 3103 3104 3105 3106 3107

	rbd_dev->spec->pool_name = kstrdup(name, GFP_KERNEL);
	if (!rbd_dev->spec->pool_name)
		return -ENOMEM;

	/* Fetch the image name; tolerate failure here */

	name = rbd_dev_image_name(rbd_dev);
A
Alex Elder 已提交
3108
	if (name)
3109
		rbd_dev->spec->image_name = (char *) name;
A
Alex Elder 已提交
3110
	else
A
Alex Elder 已提交
3111
		rbd_warn(rbd_dev, "unable to get image name");
3112 3113 3114 3115 3116

	/* Look up the snapshot name. */

	name = rbd_snap_name(rbd_dev, rbd_dev->spec->snap_id);
	if (!name) {
3117 3118
		rbd_warn(rbd_dev, "no snapshot with id %llu",
			rbd_dev->spec->snap_id);	/* Really a BUG() */
3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134
		ret = -EIO;
		goto out_err;
	}
	rbd_dev->spec->snap_name = kstrdup(name, GFP_KERNEL);
	if(!rbd_dev->spec->snap_name)
		goto out_err;

	return 0;
out_err:
	kfree(reply_buf);
	kfree(rbd_dev->spec->pool_name);
	rbd_dev->spec->pool_name = NULL;

	return ret;
}

3135
static int rbd_dev_v2_snap_context(struct rbd_device *rbd_dev, u64 *ver)
3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158
{
	size_t size;
	int ret;
	void *reply_buf;
	void *p;
	void *end;
	u64 seq;
	u32 snap_count;
	struct ceph_snap_context *snapc;
	u32 i;

	/*
	 * We'll need room for the seq value (maximum snapshot id),
	 * snapshot count, and array of that many snapshot ids.
	 * For now we have a fixed upper limit on the number we're
	 * prepared to receive.
	 */
	size = sizeof (__le64) + sizeof (__le32) +
			RBD_MAX_SNAP_COUNT * sizeof (__le64);
	reply_buf = kzalloc(size, GFP_KERNEL);
	if (!reply_buf)
		return -ENOMEM;

3159
	ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3160 3161
				"rbd", "get_snapcontext",
				NULL, 0,
3162
				reply_buf, size, ver);
3163
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211
	if (ret < 0)
		goto out;

	ret = -ERANGE;
	p = reply_buf;
	end = (char *) reply_buf + size;
	ceph_decode_64_safe(&p, end, seq, out);
	ceph_decode_32_safe(&p, end, snap_count, out);

	/*
	 * Make sure the reported number of snapshot ids wouldn't go
	 * beyond the end of our buffer.  But before checking that,
	 * make sure the computed size of the snapshot context we
	 * allocate is representable in a size_t.
	 */
	if (snap_count > (SIZE_MAX - sizeof (struct ceph_snap_context))
				 / sizeof (u64)) {
		ret = -EINVAL;
		goto out;
	}
	if (!ceph_has_room(&p, end, snap_count * sizeof (__le64)))
		goto out;

	size = sizeof (struct ceph_snap_context) +
				snap_count * sizeof (snapc->snaps[0]);
	snapc = kmalloc(size, GFP_KERNEL);
	if (!snapc) {
		ret = -ENOMEM;
		goto out;
	}

	atomic_set(&snapc->nref, 1);
	snapc->seq = seq;
	snapc->num_snaps = snap_count;
	for (i = 0; i < snap_count; i++)
		snapc->snaps[i] = ceph_decode_64(&p);

	rbd_dev->header.snapc = snapc;

	dout("  snap context seq = %llu, snap_count = %u\n",
		(unsigned long long) seq, (unsigned int) snap_count);

out:
	kfree(reply_buf);

	return 0;
}

A
Alex Elder 已提交
3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227
static char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev, u32 which)
{
	size_t size;
	void *reply_buf;
	__le64 snap_id;
	int ret;
	void *p;
	void *end;
	char *snap_name;

	size = sizeof (__le32) + RBD_MAX_SNAP_NAME_LEN;
	reply_buf = kmalloc(size, GFP_KERNEL);
	if (!reply_buf)
		return ERR_PTR(-ENOMEM);

	snap_id = cpu_to_le64(rbd_dev->header.snapc->snaps[which]);
3228
	ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
A
Alex Elder 已提交
3229 3230
				"rbd", "get_snapshot_name",
				(char *) &snap_id, sizeof (snap_id),
3231
				reply_buf, size, NULL);
3232
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
A
Alex Elder 已提交
3233 3234 3235 3236 3237
	if (ret < 0)
		goto out;

	p = reply_buf;
	end = (char *) reply_buf + size;
A
Alex Elder 已提交
3238
	snap_name = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
A
Alex Elder 已提交
3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257
	if (IS_ERR(snap_name)) {
		ret = PTR_ERR(snap_name);
		goto out;
	} else {
		dout("  snap_id 0x%016llx snap_name = %s\n",
			(unsigned long long) le64_to_cpu(snap_id), snap_name);
	}
	kfree(reply_buf);

	return snap_name;
out:
	kfree(reply_buf);

	return ERR_PTR(ret);
}

static char *rbd_dev_v2_snap_info(struct rbd_device *rbd_dev, u32 which,
		u64 *snap_size, u64 *snap_features)
{
3258
	u64 snap_id;
A
Alex Elder 已提交
3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284
	u8 order;
	int ret;

	snap_id = rbd_dev->header.snapc->snaps[which];
	ret = _rbd_dev_v2_snap_size(rbd_dev, snap_id, &order, snap_size);
	if (ret)
		return ERR_PTR(ret);
	ret = _rbd_dev_v2_snap_features(rbd_dev, snap_id, snap_features);
	if (ret)
		return ERR_PTR(ret);

	return rbd_dev_v2_snap_name(rbd_dev, which);
}

static char *rbd_dev_snap_info(struct rbd_device *rbd_dev, u32 which,
		u64 *snap_size, u64 *snap_features)
{
	if (rbd_dev->image_format == 1)
		return rbd_dev_v1_snap_info(rbd_dev, which,
					snap_size, snap_features);
	if (rbd_dev->image_format == 2)
		return rbd_dev_v2_snap_info(rbd_dev, which,
					snap_size, snap_features);
	return ERR_PTR(-EINVAL);
}

A
Alex Elder 已提交
3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319
static int rbd_dev_v2_refresh(struct rbd_device *rbd_dev, u64 *hver)
{
	int ret;
	__u8 obj_order;

	down_write(&rbd_dev->header_rwsem);

	/* Grab old order first, to see if it changes */

	obj_order = rbd_dev->header.obj_order,
	ret = rbd_dev_v2_image_size(rbd_dev);
	if (ret)
		goto out;
	if (rbd_dev->header.obj_order != obj_order) {
		ret = -EIO;
		goto out;
	}
	rbd_update_mapping_size(rbd_dev);

	ret = rbd_dev_v2_snap_context(rbd_dev, hver);
	dout("rbd_dev_v2_snap_context returned %d\n", ret);
	if (ret)
		goto out;
	ret = rbd_dev_snaps_update(rbd_dev);
	dout("rbd_dev_snaps_update returned %d\n", ret);
	if (ret)
		goto out;
	ret = rbd_dev_snaps_register(rbd_dev);
	dout("rbd_dev_snaps_register returned %d\n", ret);
out:
	up_write(&rbd_dev->header_rwsem);

	return ret;
}

3320
/*
3321 3322 3323 3324 3325 3326 3327 3328 3329 3330
 * Scan the rbd device's current snapshot list and compare it to the
 * newly-received snapshot context.  Remove any existing snapshots
 * not present in the new snapshot context.  Add a new snapshot for
 * any snaphots in the snapshot context not in the current list.
 * And verify there are no changes to snapshots we already know
 * about.
 *
 * Assumes the snapshots in the snapshot context are sorted by
 * snapshot id, highest id first.  (Snapshots in the rbd_dev's list
 * are also maintained in that order.)
3331
 */
3332
static int rbd_dev_snaps_update(struct rbd_device *rbd_dev)
3333
{
3334 3335 3336 3337 3338
	struct ceph_snap_context *snapc = rbd_dev->header.snapc;
	const u32 snap_count = snapc->num_snaps;
	struct list_head *head = &rbd_dev->snaps;
	struct list_head *links = head->next;
	u32 index = 0;
3339

A
Alex Elder 已提交
3340
	dout("%s: snap count is %u\n", __func__, (unsigned int) snap_count);
3341 3342 3343
	while (index < snap_count || links != head) {
		u64 snap_id;
		struct rbd_snap *snap;
3344 3345 3346
		char *snap_name;
		u64 snap_size = 0;
		u64 snap_features = 0;
3347

3348 3349 3350 3351
		snap_id = index < snap_count ? snapc->snaps[index]
					     : CEPH_NOSNAP;
		snap = links != head ? list_entry(links, struct rbd_snap, node)
				     : NULL;
A
Alex Elder 已提交
3352
		rbd_assert(!snap || snap->id != CEPH_NOSNAP);
3353

3354 3355
		if (snap_id == CEPH_NOSNAP || (snap && snap->id > snap_id)) {
			struct list_head *next = links->next;
3356

3357 3358 3359 3360 3361 3362 3363 3364 3365
			/*
			 * A previously-existing snapshot is not in
			 * the new snap context.
			 *
			 * If the now missing snapshot is the one the
			 * image is mapped to, clear its exists flag
			 * so we can avoid sending any more requests
			 * to it.
			 */
3366
			if (rbd_dev->spec->snap_id == snap->id)
3367
				clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
3368
			rbd_remove_snap_dev(snap);
A
Alex Elder 已提交
3369
			dout("%ssnap id %llu has been removed\n",
3370 3371
				rbd_dev->spec->snap_id == snap->id ?
							"mapped " : "",
A
Alex Elder 已提交
3372
				(unsigned long long) snap->id);
3373 3374 3375 3376

			/* Done with this list entry; advance */

			links = next;
3377 3378
			continue;
		}
3379

A
Alex Elder 已提交
3380 3381
		snap_name = rbd_dev_snap_info(rbd_dev, index,
					&snap_size, &snap_features);
3382 3383 3384
		if (IS_ERR(snap_name))
			return PTR_ERR(snap_name);

A
Alex Elder 已提交
3385 3386
		dout("entry %u: snap_id = %llu\n", (unsigned int) snap_count,
			(unsigned long long) snap_id);
3387 3388 3389 3390 3391
		if (!snap || (snap_id != CEPH_NOSNAP && snap->id < snap_id)) {
			struct rbd_snap *new_snap;

			/* We haven't seen this snapshot before */

3392
			new_snap = __rbd_add_snap_dev(rbd_dev, snap_name,
3393
					snap_id, snap_size, snap_features);
A
Alex Elder 已提交
3394 3395 3396 3397 3398 3399 3400
			if (IS_ERR(new_snap)) {
				int err = PTR_ERR(new_snap);

				dout("  failed to add dev, error %d\n", err);

				return err;
			}
3401 3402 3403

			/* New goes before existing, or at end of list */

A
Alex Elder 已提交
3404
			dout("  added dev%s\n", snap ? "" : " at end\n");
3405 3406 3407
			if (snap)
				list_add_tail(&new_snap->node, &snap->node);
			else
A
Alex Elder 已提交
3408
				list_add_tail(&new_snap->node, head);
3409 3410 3411
		} else {
			/* Already have this one */

A
Alex Elder 已提交
3412 3413
			dout("  already present\n");

3414
			rbd_assert(snap->size == snap_size);
A
Alex Elder 已提交
3415
			rbd_assert(!strcmp(snap->name, snap_name));
3416
			rbd_assert(snap->features == snap_features);
3417 3418 3419 3420

			/* Done with this list entry; advance */

			links = links->next;
3421
		}
3422 3423 3424 3425

		/* Advance to the next entry in the snapshot context */

		index++;
3426
	}
A
Alex Elder 已提交
3427
	dout("%s: done\n", __func__);
3428 3429 3430 3431

	return 0;
}

3432 3433 3434 3435 3436 3437 3438 3439 3440
/*
 * Scan the list of snapshots and register the devices for any that
 * have not already been registered.
 */
static int rbd_dev_snaps_register(struct rbd_device *rbd_dev)
{
	struct rbd_snap *snap;
	int ret = 0;

A
Alex Elder 已提交
3441
	dout("%s:\n", __func__);
3442 3443
	if (WARN_ON(!device_is_registered(&rbd_dev->dev)))
		return -EIO;
3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456

	list_for_each_entry(snap, &rbd_dev->snaps, node) {
		if (!rbd_snap_registered(snap)) {
			ret = rbd_register_snap_dev(snap, &rbd_dev->dev);
			if (ret < 0)
				break;
		}
	}
	dout("%s: returning %d\n", __func__, ret);

	return ret;
}

3457 3458 3459
static int rbd_bus_add_dev(struct rbd_device *rbd_dev)
{
	struct device *dev;
3460
	int ret;
3461 3462 3463

	mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);

3464
	dev = &rbd_dev->dev;
3465 3466 3467 3468
	dev->bus = &rbd_bus_type;
	dev->type = &rbd_device_type;
	dev->parent = &rbd_root_dev;
	dev->release = rbd_dev_release;
A
Alex Elder 已提交
3469
	dev_set_name(dev, "%d", rbd_dev->dev_id);
3470 3471 3472
	ret = device_register(dev);

	mutex_unlock(&ctl_mutex);
3473

3474
	return ret;
3475 3476
}

3477 3478 3479 3480 3481
static void rbd_bus_del_dev(struct rbd_device *rbd_dev)
{
	device_unregister(&rbd_dev->dev);
}

A
Alex Elder 已提交
3482
static atomic64_t rbd_dev_id_max = ATOMIC64_INIT(0);
3483 3484

/*
3485 3486
 * Get a unique rbd identifier for the given new rbd_dev, and add
 * the rbd_dev to the global list.  The minimum rbd id is 1.
3487
 */
A
Alex Elder 已提交
3488
static void rbd_dev_id_get(struct rbd_device *rbd_dev)
3489
{
A
Alex Elder 已提交
3490
	rbd_dev->dev_id = atomic64_inc_return(&rbd_dev_id_max);
3491 3492 3493 3494

	spin_lock(&rbd_dev_list_lock);
	list_add_tail(&rbd_dev->node, &rbd_dev_list);
	spin_unlock(&rbd_dev_list_lock);
A
Alex Elder 已提交
3495 3496
	dout("rbd_dev %p given dev id %llu\n", rbd_dev,
		(unsigned long long) rbd_dev->dev_id);
3497
}
3498

3499
/*
3500 3501
 * Remove an rbd_dev from the global list, and record that its
 * identifier is no longer in use.
3502
 */
A
Alex Elder 已提交
3503
static void rbd_dev_id_put(struct rbd_device *rbd_dev)
3504
{
3505
	struct list_head *tmp;
A
Alex Elder 已提交
3506
	int rbd_id = rbd_dev->dev_id;
3507 3508
	int max_id;

A
Alex Elder 已提交
3509
	rbd_assert(rbd_id > 0);
3510

A
Alex Elder 已提交
3511 3512
	dout("rbd_dev %p released dev id %llu\n", rbd_dev,
		(unsigned long long) rbd_dev->dev_id);
3513 3514
	spin_lock(&rbd_dev_list_lock);
	list_del_init(&rbd_dev->node);
3515 3516 3517 3518 3519

	/*
	 * If the id being "put" is not the current maximum, there
	 * is nothing special we need to do.
	 */
A
Alex Elder 已提交
3520
	if (rbd_id != atomic64_read(&rbd_dev_id_max)) {
3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534
		spin_unlock(&rbd_dev_list_lock);
		return;
	}

	/*
	 * We need to update the current maximum id.  Search the
	 * list to find out what it is.  We're more likely to find
	 * the maximum at the end, so search the list backward.
	 */
	max_id = 0;
	list_for_each_prev(tmp, &rbd_dev_list) {
		struct rbd_device *rbd_dev;

		rbd_dev = list_entry(tmp, struct rbd_device, node);
A
Alex Elder 已提交
3535 3536
		if (rbd_dev->dev_id > max_id)
			max_id = rbd_dev->dev_id;
3537
	}
3538
	spin_unlock(&rbd_dev_list_lock);
3539

3540
	/*
A
Alex Elder 已提交
3541
	 * The max id could have been updated by rbd_dev_id_get(), in
3542 3543 3544
	 * which case it now accurately reflects the new maximum.
	 * Be careful not to overwrite the maximum value in that
	 * case.
3545
	 */
A
Alex Elder 已提交
3546 3547
	atomic64_cmpxchg(&rbd_dev_id_max, rbd_id, max_id);
	dout("  max dev id has been reset\n");
3548 3549
}

3550 3551 3552
/*
 * Skips over white space at *buf, and updates *buf to point to the
 * first found non-space character (if any). Returns the length of
A
Alex Elder 已提交
3553 3554
 * the token (string of non-white space characters) found.  Note
 * that *buf must be terminated with '\0'.
3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571
 */
static inline size_t next_token(const char **buf)
{
        /*
        * These are the characters that produce nonzero for
        * isspace() in the "C" and "POSIX" locales.
        */
        const char *spaces = " \f\n\r\t\v";

        *buf += strspn(*buf, spaces);	/* Find start of token */

	return strcspn(*buf, spaces);   /* Return token length */
}

/*
 * Finds the next token in *buf, and if the provided token buffer is
 * big enough, copies the found token into it.  The result, if
A
Alex Elder 已提交
3572 3573
 * copied, is guaranteed to be terminated with '\0'.  Note that *buf
 * must be terminated with '\0' on entry.
3574 3575 3576 3577 3578
 *
 * Returns the length of the token found (not including the '\0').
 * Return value will be 0 if no token is found, and it will be >=
 * token_size if the token would not fit.
 *
A
Alex Elder 已提交
3579
 * The *buf pointer will be updated to point beyond the end of the
3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598
 * found token.  Note that this occurs even if the token buffer is
 * too small to hold it.
 */
static inline size_t copy_token(const char **buf,
				char *token,
				size_t token_size)
{
        size_t len;

	len = next_token(buf);
	if (len < token_size) {
		memcpy(token, *buf, len);
		*(token + len) = '\0';
	}
	*buf += len;

        return len;
}

A
Alex Elder 已提交
3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620
/*
 * Finds the next token in *buf, dynamically allocates a buffer big
 * enough to hold a copy of it, and copies the token into the new
 * buffer.  The copy is guaranteed to be terminated with '\0'.  Note
 * that a duplicate buffer is created even for a zero-length token.
 *
 * Returns a pointer to the newly-allocated duplicate, or a null
 * pointer if memory for the duplicate was not available.  If
 * the lenp argument is a non-null pointer, the length of the token
 * (not including the '\0') is returned in *lenp.
 *
 * If successful, the *buf pointer will be updated to point beyond
 * the end of the found token.
 *
 * Note: uses GFP_KERNEL for allocation.
 */
static inline char *dup_token(const char **buf, size_t *lenp)
{
	char *dup;
	size_t len;

	len = next_token(buf);
A
Alex Elder 已提交
3621
	dup = kmemdup(*buf, len + 1, GFP_KERNEL);
A
Alex Elder 已提交
3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632
	if (!dup)
		return NULL;
	*(dup + len) = '\0';
	*buf += len;

	if (lenp)
		*lenp = len;

	return dup;
}

3633
/*
3634 3635 3636 3637
 * Parse the options provided for an "rbd add" (i.e., rbd image
 * mapping) request.  These arrive via a write to /sys/bus/rbd/add,
 * and the data written is passed here via a NUL-terminated buffer.
 * Returns 0 if successful or an error code otherwise.
A
Alex Elder 已提交
3638
 *
3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672
 * The information extracted from these options is recorded in
 * the other parameters which return dynamically-allocated
 * structures:
 *  ceph_opts
 *      The address of a pointer that will refer to a ceph options
 *      structure.  Caller must release the returned pointer using
 *      ceph_destroy_options() when it is no longer needed.
 *  rbd_opts
 *	Address of an rbd options pointer.  Fully initialized by
 *	this function; caller must release with kfree().
 *  spec
 *	Address of an rbd image specification pointer.  Fully
 *	initialized by this function based on parsed options.
 *	Caller must release with rbd_spec_put().
 *
 * The options passed take this form:
 *  <mon_addrs> <options> <pool_name> <image_name> [<snap_id>]
 * where:
 *  <mon_addrs>
 *      A comma-separated list of one or more monitor addresses.
 *      A monitor address is an ip address, optionally followed
 *      by a port number (separated by a colon).
 *        I.e.:  ip1[:port1][,ip2[:port2]...]
 *  <options>
 *      A comma-separated list of ceph and/or rbd options.
 *  <pool_name>
 *      The name of the rados pool containing the rbd image.
 *  <image_name>
 *      The name of the image in that pool to map.
 *  <snap_id>
 *      An optional snapshot id.  If provided, the mapping will
 *      present data from the image at the time that snapshot was
 *      created.  The image head is used if no snapshot id is
 *      provided.  Snapshot mappings are always read-only.
3673
 */
3674
static int rbd_add_parse_args(const char *buf,
3675
				struct ceph_options **ceph_opts,
3676 3677
				struct rbd_options **opts,
				struct rbd_spec **rbd_spec)
3678
{
A
Alex Elder 已提交
3679
	size_t len;
3680
	char *options;
3681 3682
	const char *mon_addrs;
	size_t mon_addrs_size;
3683
	struct rbd_spec *spec = NULL;
3684
	struct rbd_options *rbd_opts = NULL;
3685
	struct ceph_options *copts;
3686
	int ret;
3687 3688 3689

	/* The first four tokens are required */

3690
	len = next_token(&buf);
3691 3692 3693 3694
	if (!len) {
		rbd_warn(NULL, "no monitor address(es) provided");
		return -EINVAL;
	}
3695
	mon_addrs = buf;
3696
	mon_addrs_size = len + 1;
3697
	buf += len;
3698

3699
	ret = -EINVAL;
3700 3701
	options = dup_token(&buf, NULL);
	if (!options)
3702
		return -ENOMEM;
3703 3704 3705 3706
	if (!*options) {
		rbd_warn(NULL, "no options provided");
		goto out_err;
	}
3707

3708 3709
	spec = rbd_spec_alloc();
	if (!spec)
3710
		goto out_mem;
3711 3712 3713 3714

	spec->pool_name = dup_token(&buf, NULL);
	if (!spec->pool_name)
		goto out_mem;
3715 3716 3717 3718
	if (!*spec->pool_name) {
		rbd_warn(NULL, "no pool name provided");
		goto out_err;
	}
3719

A
Alex Elder 已提交
3720
	spec->image_name = dup_token(&buf, NULL);
3721
	if (!spec->image_name)
3722
		goto out_mem;
3723 3724 3725 3726
	if (!*spec->image_name) {
		rbd_warn(NULL, "no image name provided");
		goto out_err;
	}
3727

3728 3729 3730 3731
	/*
	 * Snapshot name is optional; default is to use "-"
	 * (indicating the head/no snapshot).
	 */
3732
	len = next_token(&buf);
3733
	if (!len) {
3734 3735
		buf = RBD_SNAP_HEAD_NAME; /* No snapshot supplied */
		len = sizeof (RBD_SNAP_HEAD_NAME) - 1;
3736
	} else if (len > RBD_MAX_SNAP_NAME_LEN) {
3737
		ret = -ENAMETOOLONG;
3738
		goto out_err;
3739
	}
A
Alex Elder 已提交
3740
	spec->snap_name = kmemdup(buf, len + 1, GFP_KERNEL);
3741
	if (!spec->snap_name)
3742
		goto out_mem;
3743
	*(spec->snap_name + len) = '\0';
A
Alex Elder 已提交
3744

3745
	/* Initialize all rbd options to the defaults */
3746

3747 3748 3749 3750 3751
	rbd_opts = kzalloc(sizeof (*rbd_opts), GFP_KERNEL);
	if (!rbd_opts)
		goto out_mem;

	rbd_opts->read_only = RBD_READ_ONLY_DEFAULT;
A
Alex Elder 已提交
3752

3753
	copts = ceph_parse_options(options, mon_addrs,
3754
					mon_addrs + mon_addrs_size - 1,
3755
					parse_rbd_opts_token, rbd_opts);
3756 3757
	if (IS_ERR(copts)) {
		ret = PTR_ERR(copts);
3758 3759
		goto out_err;
	}
3760 3761 3762
	kfree(options);

	*ceph_opts = copts;
3763
	*opts = rbd_opts;
3764
	*rbd_spec = spec;
3765

3766
	return 0;
3767
out_mem:
3768
	ret = -ENOMEM;
A
Alex Elder 已提交
3769
out_err:
3770 3771
	kfree(rbd_opts);
	rbd_spec_put(spec);
3772
	kfree(options);
A
Alex Elder 已提交
3773

3774
	return ret;
3775 3776
}

A
Alex Elder 已提交
3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798
/*
 * An rbd format 2 image has a unique identifier, distinct from the
 * name given to it by the user.  Internally, that identifier is
 * what's used to specify the names of objects related to the image.
 *
 * A special "rbd id" object is used to map an rbd image name to its
 * id.  If that object doesn't exist, then there is no v2 rbd image
 * with the supplied name.
 *
 * This function will record the given rbd_dev's image_id field if
 * it can be determined, and in that case will return 0.  If any
 * errors occur a negative errno will be returned and the rbd_dev's
 * image_id field will be unchanged (and should be NULL).
 */
static int rbd_dev_image_id(struct rbd_device *rbd_dev)
{
	int ret;
	size_t size;
	char *object_name;
	void *response;
	void *p;

A
Alex Elder 已提交
3799 3800 3801 3802 3803 3804 3805 3806
	/*
	 * When probing a parent image, the image id is already
	 * known (and the image name likely is not).  There's no
	 * need to fetch the image id again in this case.
	 */
	if (rbd_dev->spec->image_id)
		return 0;

A
Alex Elder 已提交
3807 3808 3809 3810
	/*
	 * First, see if the format 2 image id file exists, and if
	 * so, get the image's persistent id from it.
	 */
A
Alex Elder 已提交
3811
	size = sizeof (RBD_ID_PREFIX) + strlen(rbd_dev->spec->image_name);
A
Alex Elder 已提交
3812 3813 3814
	object_name = kmalloc(size, GFP_NOIO);
	if (!object_name)
		return -ENOMEM;
3815
	sprintf(object_name, "%s%s", RBD_ID_PREFIX, rbd_dev->spec->image_name);
A
Alex Elder 已提交
3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826
	dout("rbd id object name is %s\n", object_name);

	/* Response will be an encoded string, which includes a length */

	size = sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX;
	response = kzalloc(size, GFP_NOIO);
	if (!response) {
		ret = -ENOMEM;
		goto out;
	}

3827
	ret = rbd_obj_method_sync(rbd_dev, object_name,
A
Alex Elder 已提交
3828 3829
				"rbd", "get_id",
				NULL, 0,
3830
				response, RBD_IMAGE_ID_LEN_MAX, NULL);
3831
	dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
A
Alex Elder 已提交
3832 3833 3834 3835
	if (ret < 0)
		goto out;

	p = response;
3836
	rbd_dev->spec->image_id = ceph_extract_encoded_string(&p,
A
Alex Elder 已提交
3837
						p + RBD_IMAGE_ID_LEN_MAX,
A
Alex Elder 已提交
3838
						NULL, GFP_NOIO);
3839 3840 3841
	if (IS_ERR(rbd_dev->spec->image_id)) {
		ret = PTR_ERR(rbd_dev->spec->image_id);
		rbd_dev->spec->image_id = NULL;
A
Alex Elder 已提交
3842
	} else {
3843
		dout("image_id is %s\n", rbd_dev->spec->image_id);
A
Alex Elder 已提交
3844 3845 3846 3847 3848 3849 3850 3851
	}
out:
	kfree(response);
	kfree(object_name);

	return ret;
}

3852 3853 3854 3855 3856 3857 3858
static int rbd_dev_v1_probe(struct rbd_device *rbd_dev)
{
	int ret;
	size_t size;

	/* Version 1 images have no id; empty string is used */

3859 3860
	rbd_dev->spec->image_id = kstrdup("", GFP_KERNEL);
	if (!rbd_dev->spec->image_id)
3861 3862 3863 3864
		return -ENOMEM;

	/* Record the header object name for this rbd image. */

A
Alex Elder 已提交
3865
	size = strlen(rbd_dev->spec->image_name) + sizeof (RBD_SUFFIX);
3866 3867 3868 3869 3870
	rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
	if (!rbd_dev->header_name) {
		ret = -ENOMEM;
		goto out_err;
	}
3871 3872
	sprintf(rbd_dev->header_name, "%s%s",
		rbd_dev->spec->image_name, RBD_SUFFIX);
3873 3874 3875 3876 3877 3878

	/* Populate rbd image metadata */

	ret = rbd_read_header(rbd_dev, &rbd_dev->header);
	if (ret < 0)
		goto out_err;
3879 3880 3881 3882 3883 3884

	/* Version 1 images have no parent (no layering) */

	rbd_dev->parent_spec = NULL;
	rbd_dev->parent_overlap = 0;

3885 3886 3887 3888 3889 3890 3891 3892 3893 3894
	rbd_dev->image_format = 1;

	dout("discovered version 1 image, header name is %s\n",
		rbd_dev->header_name);

	return 0;

out_err:
	kfree(rbd_dev->header_name);
	rbd_dev->header_name = NULL;
3895 3896
	kfree(rbd_dev->spec->image_id);
	rbd_dev->spec->image_id = NULL;
3897 3898 3899 3900 3901 3902 3903

	return ret;
}

static int rbd_dev_v2_probe(struct rbd_device *rbd_dev)
{
	size_t size;
3904
	int ret;
3905
	u64 ver = 0;
3906 3907 3908 3909 3910

	/*
	 * Image id was filled in by the caller.  Record the header
	 * object name for this rbd image.
	 */
A
Alex Elder 已提交
3911
	size = sizeof (RBD_HEADER_PREFIX) + strlen(rbd_dev->spec->image_id);
3912 3913 3914 3915
	rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
	if (!rbd_dev->header_name)
		return -ENOMEM;
	sprintf(rbd_dev->header_name, "%s%s",
3916
			RBD_HEADER_PREFIX, rbd_dev->spec->image_id);
3917 3918 3919 3920

	/* Get the size and object order for the image */

	ret = rbd_dev_v2_image_size(rbd_dev);
3921 3922 3923 3924 3925 3926
	if (ret < 0)
		goto out_err;

	/* Get the object prefix (a.k.a. block_name) for the image */

	ret = rbd_dev_v2_object_prefix(rbd_dev);
3927 3928 3929
	if (ret < 0)
		goto out_err;

A
Alex Elder 已提交
3930
	/* Get the and check features for the image */
3931 3932

	ret = rbd_dev_v2_features(rbd_dev);
3933 3934
	if (ret < 0)
		goto out_err;
3935

3936 3937 3938 3939 3940 3941 3942 3943
	/* If the image supports layering, get the parent info */

	if (rbd_dev->header.features & RBD_FEATURE_LAYERING) {
		ret = rbd_dev_v2_parent_info(rbd_dev);
		if (ret < 0)
			goto out_err;
	}

3944 3945 3946 3947
	/* crypto and compression type aren't (yet) supported for v2 images */

	rbd_dev->header.crypt_type = 0;
	rbd_dev->header.comp_type = 0;
3948

3949 3950 3951
	/* Get the snapshot context, plus the header version */

	ret = rbd_dev_v2_snap_context(rbd_dev, &ver);
3952 3953
	if (ret)
		goto out_err;
3954 3955
	rbd_dev->header.obj_version = ver;

3956 3957 3958 3959 3960
	rbd_dev->image_format = 2;

	dout("discovered version 2 image, header name is %s\n",
		rbd_dev->header_name);

A
Alex Elder 已提交
3961
	return 0;
3962
out_err:
3963 3964 3965
	rbd_dev->parent_overlap = 0;
	rbd_spec_put(rbd_dev->parent_spec);
	rbd_dev->parent_spec = NULL;
3966 3967
	kfree(rbd_dev->header_name);
	rbd_dev->header_name = NULL;
3968 3969
	kfree(rbd_dev->header.object_prefix);
	rbd_dev->header.object_prefix = NULL;
3970 3971

	return ret;
3972 3973
}

A
Alex Elder 已提交
3974 3975 3976 3977 3978 3979 3980 3981 3982
static int rbd_dev_probe_finish(struct rbd_device *rbd_dev)
{
	int ret;

	/* no need to lock here, as rbd_dev is not registered yet */
	ret = rbd_dev_snaps_update(rbd_dev);
	if (ret)
		return ret;

3983 3984 3985 3986
	ret = rbd_dev_probe_update_spec(rbd_dev);
	if (ret)
		goto err_out_snaps;

A
Alex Elder 已提交
3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025
	ret = rbd_dev_set_mapping(rbd_dev);
	if (ret)
		goto err_out_snaps;

	/* generate unique id: find highest unique id, add one */
	rbd_dev_id_get(rbd_dev);

	/* Fill in the device name, now that we have its id. */
	BUILD_BUG_ON(DEV_NAME_LEN
			< sizeof (RBD_DRV_NAME) + MAX_INT_FORMAT_WIDTH);
	sprintf(rbd_dev->name, "%s%d", RBD_DRV_NAME, rbd_dev->dev_id);

	/* Get our block major device number. */

	ret = register_blkdev(0, rbd_dev->name);
	if (ret < 0)
		goto err_out_id;
	rbd_dev->major = ret;

	/* Set up the blkdev mapping. */

	ret = rbd_init_disk(rbd_dev);
	if (ret)
		goto err_out_blkdev;

	ret = rbd_bus_add_dev(rbd_dev);
	if (ret)
		goto err_out_disk;

	/*
	 * At this point cleanup in the event of an error is the job
	 * of the sysfs code (initiated by rbd_bus_del_dev()).
	 */
	down_write(&rbd_dev->header_rwsem);
	ret = rbd_dev_snaps_register(rbd_dev);
	up_write(&rbd_dev->header_rwsem);
	if (ret)
		goto err_out_bus;

4026
	ret = rbd_dev_header_watch_sync(rbd_dev, 1);
A
Alex Elder 已提交
4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055
	if (ret)
		goto err_out_bus;

	/* Everything's ready.  Announce the disk to the world. */

	add_disk(rbd_dev->disk);

	pr_info("%s: added with size 0x%llx\n", rbd_dev->disk->disk_name,
		(unsigned long long) rbd_dev->mapping.size);

	return ret;
err_out_bus:
	/* this will also clean up rest of rbd_dev stuff */

	rbd_bus_del_dev(rbd_dev);

	return ret;
err_out_disk:
	rbd_free_disk(rbd_dev);
err_out_blkdev:
	unregister_blkdev(rbd_dev->major, rbd_dev->name);
err_out_id:
	rbd_dev_id_put(rbd_dev);
err_out_snaps:
	rbd_remove_all_snaps(rbd_dev);

	return ret;
}

4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074
/*
 * Probe for the existence of the header object for the given rbd
 * device.  For format 2 images this includes determining the image
 * id.
 */
static int rbd_dev_probe(struct rbd_device *rbd_dev)
{
	int ret;

	/*
	 * Get the id from the image id object.  If it's not a
	 * format 2 image, we'll get ENOENT back, and we'll assume
	 * it's a format 1 image.
	 */
	ret = rbd_dev_image_id(rbd_dev);
	if (ret)
		ret = rbd_dev_v1_probe(rbd_dev);
	else
		ret = rbd_dev_v2_probe(rbd_dev);
A
Alex Elder 已提交
4075
	if (ret) {
4076 4077
		dout("probe failed, returning %d\n", ret);

A
Alex Elder 已提交
4078 4079 4080 4081 4082 4083 4084
		return ret;
	}

	ret = rbd_dev_probe_finish(rbd_dev);
	if (ret)
		rbd_header_free(&rbd_dev->header);

4085 4086 4087
	return ret;
}

4088 4089 4090
static ssize_t rbd_add(struct bus_type *bus,
		       const char *buf,
		       size_t count)
4091
{
4092
	struct rbd_device *rbd_dev = NULL;
4093
	struct ceph_options *ceph_opts = NULL;
4094
	struct rbd_options *rbd_opts = NULL;
4095
	struct rbd_spec *spec = NULL;
4096
	struct rbd_client *rbdc;
4097 4098
	struct ceph_osd_client *osdc;
	int rc = -ENOMEM;
4099 4100 4101 4102 4103

	if (!try_module_get(THIS_MODULE))
		return -ENODEV;

	/* parse add command */
4104
	rc = rbd_add_parse_args(buf, &ceph_opts, &rbd_opts, &spec);
4105
	if (rc < 0)
4106
		goto err_out_module;
4107

4108 4109 4110
	rbdc = rbd_get_client(ceph_opts);
	if (IS_ERR(rbdc)) {
		rc = PTR_ERR(rbdc);
4111
		goto err_out_args;
4112
	}
4113
	ceph_opts = NULL;	/* rbd_dev client now owns this */
4114 4115

	/* pick the pool */
4116
	osdc = &rbdc->client->osdc;
4117
	rc = ceph_pg_poolid_by_name(osdc->osdmap, spec->pool_name);
4118 4119
	if (rc < 0)
		goto err_out_client;
4120 4121
	spec->pool_id = (u64) rc;

4122 4123 4124 4125 4126 4127 4128
	/* The ceph file layout needs to fit pool id in 32 bits */

	if (WARN_ON(spec->pool_id > (u64) U32_MAX)) {
		rc = -EIO;
		goto err_out_client;
	}

4129
	rbd_dev = rbd_dev_create(rbdc, spec);
4130 4131
	if (!rbd_dev)
		goto err_out_client;
4132 4133
	rbdc = NULL;		/* rbd_dev now owns this */
	spec = NULL;		/* rbd_dev now owns this */
4134

4135
	rbd_dev->mapping.read_only = rbd_opts->read_only;
4136 4137
	kfree(rbd_opts);
	rbd_opts = NULL;	/* done with this */
4138

4139 4140
	rc = rbd_dev_probe(rbd_dev);
	if (rc < 0)
4141
		goto err_out_rbd_dev;
4142

4143
	return count;
4144 4145
err_out_rbd_dev:
	rbd_dev_destroy(rbd_dev);
4146
err_out_client:
4147
	rbd_put_client(rbdc);
4148
err_out_args:
4149 4150
	if (ceph_opts)
		ceph_destroy_options(ceph_opts);
4151
	kfree(rbd_opts);
4152
	rbd_spec_put(spec);
4153 4154
err_out_module:
	module_put(THIS_MODULE);
4155

4156
	dout("Error adding device %s\n", buf);
4157 4158

	return (ssize_t) rc;
4159 4160
}

A
Alex Elder 已提交
4161
static struct rbd_device *__rbd_get_dev(unsigned long dev_id)
4162 4163 4164 4165
{
	struct list_head *tmp;
	struct rbd_device *rbd_dev;

4166
	spin_lock(&rbd_dev_list_lock);
4167 4168
	list_for_each(tmp, &rbd_dev_list) {
		rbd_dev = list_entry(tmp, struct rbd_device, node);
A
Alex Elder 已提交
4169
		if (rbd_dev->dev_id == dev_id) {
4170
			spin_unlock(&rbd_dev_list_lock);
4171
			return rbd_dev;
4172
		}
4173
	}
4174
	spin_unlock(&rbd_dev_list_lock);
4175 4176 4177
	return NULL;
}

4178
static void rbd_dev_release(struct device *dev)
4179
{
A
Alex Elder 已提交
4180
	struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4181

4182
	if (rbd_dev->watch_event)
4183
		rbd_dev_header_watch_sync(rbd_dev, 0);
4184 4185 4186 4187

	/* clean up and free blkdev */
	rbd_free_disk(rbd_dev);
	unregister_blkdev(rbd_dev->major, rbd_dev->name);
4188

4189 4190 4191
	/* release allocated disk header fields */
	rbd_header_free(&rbd_dev->header);

4192
	/* done with the id, and with the rbd_dev */
A
Alex Elder 已提交
4193
	rbd_dev_id_put(rbd_dev);
4194 4195
	rbd_assert(rbd_dev->rbd_client != NULL);
	rbd_dev_destroy(rbd_dev);
4196 4197 4198 4199 4200

	/* release module ref */
	module_put(THIS_MODULE);
}

4201 4202 4203
static ssize_t rbd_remove(struct bus_type *bus,
			  const char *buf,
			  size_t count)
4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224
{
	struct rbd_device *rbd_dev = NULL;
	int target_id, rc;
	unsigned long ul;
	int ret = count;

	rc = strict_strtoul(buf, 10, &ul);
	if (rc)
		return rc;

	/* convert to int; abort if we lost anything in the conversion */
	target_id = (int) ul;
	if (target_id != ul)
		return -EINVAL;

	mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);

	rbd_dev = __rbd_get_dev(target_id);
	if (!rbd_dev) {
		ret = -ENOENT;
		goto done;
4225 4226
	}

4227
	spin_lock_irq(&rbd_dev->lock);
4228
	if (rbd_dev->open_count)
4229
		ret = -EBUSY;
4230 4231
	else
		set_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags);
4232
	spin_unlock_irq(&rbd_dev->lock);
4233
	if (ret < 0)
4234
		goto done;
4235

4236
	rbd_remove_all_snaps(rbd_dev);
4237
	rbd_bus_del_dev(rbd_dev);
4238 4239 4240

done:
	mutex_unlock(&ctl_mutex);
A
Alex Elder 已提交
4241

4242 4243 4244 4245 4246
	return ret;
}

/*
 * create control files in sysfs
4247
 * /sys/bus/rbd/...
4248 4249 4250
 */
static int rbd_sysfs_init(void)
{
4251
	int ret;
4252

4253
	ret = device_register(&rbd_root_dev);
A
Alex Elder 已提交
4254
	if (ret < 0)
4255
		return ret;
4256

4257 4258 4259
	ret = bus_register(&rbd_bus_type);
	if (ret < 0)
		device_unregister(&rbd_root_dev);
4260 4261 4262 4263 4264 4265

	return ret;
}

static void rbd_sysfs_cleanup(void)
{
4266
	bus_unregister(&rbd_bus_type);
4267
	device_unregister(&rbd_root_dev);
4268 4269
}

A
Alex Elder 已提交
4270
static int __init rbd_init(void)
4271 4272 4273
{
	int rc;

4274 4275 4276 4277 4278
	if (!libceph_compatible(NULL)) {
		rbd_warn(NULL, "libceph incompatibility (quitting)");

		return -EINVAL;
	}
4279 4280 4281
	rc = rbd_sysfs_init();
	if (rc)
		return rc;
A
Alex Elder 已提交
4282
	pr_info("loaded " RBD_DRV_NAME_LONG "\n");
4283 4284 4285
	return 0;
}

A
Alex Elder 已提交
4286
static void __exit rbd_exit(void)
4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301
{
	rbd_sysfs_cleanup();
}

module_init(rbd_init);
module_exit(rbd_exit);

MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
MODULE_DESCRIPTION("rados block device");

/* following authorship retained from original osdblk.c */
MODULE_AUTHOR("Jeff Garzik <jeff@garzik.org>");

MODULE_LICENSE("GPL");