[ceph.git] / ceph / src / include / rbd_types.h

/*
 * Ceph - scalable distributed file system
 *
 * Copyright (C) 2004-2010 Sage Weil <sage@newdream.net>
 *
 * This is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 2.1, as published by the Free Software
 * Foundation.  See file COPYING.
 *
 */

#ifndef CEPH_RBD_TYPES_H
#define CEPH_RBD_TYPES_H

#include "include/types.h"
#include "rbd/features.h"

/* New-style rbd image 'foo' consists of objects
 *   rbd_id.foo              - id of image
 *   rbd_header.<id>         - image metadata
 *   rbd_object_map.<id>     - optional image object map
 *   rbd_data.<id>.00000000
 *   rbd_data.<id>.00000001
 *   ...                     - data
 */

#define RBD_HEADER_PREFIX      "rbd_header."
#define RBD_OBJECT_MAP_PREFIX  "rbd_object_map."
#define RBD_DATA_PREFIX        "rbd_data."
#define RBD_ID_PREFIX          "rbd_id."

/*
 * old-style rbd image 'foo' consists of objects
 *   foo.rbd      - image metadata
 *   rb.<idhi>.<idlo>.00000000
 *   rb.<idhi>.<idlo>.00000001
 *   ...          - data
 */

#define RBD_SUFFIX	 	".rbd"
#define RBD_DIRECTORY           "rbd_directory"
#define RBD_INFO                "rbd_info"
#define RBD_NAMESPACE           "rbd_namespace"
#define RBD_TASK                "rbd_task"

/*
 * rbd_children object in each pool contains omap entries
 * that map parent (poolid, imageid, snapid) to a list of children
 * (imageids; snapids aren't required because we get all the snapshot
 * info from a read of the child's header object anyway).
 *
 * The clone operation writes a new item to this child list, and rm or
 * flatten removes an item, and may remove the whole entry if no children
 * exist after the rm/flatten.
 *
 * When attempting to remove a parent, all pools are searched for
 * rbd_children objects with entries referring to that parent; if any
 * exist (and those children exist), the parent removal is prevented.
 */
#define RBD_CHILDREN		"rbd_children"
#define RBD_LOCK_NAME		"rbd_lock"

/**
 * rbd_mirroring object in each pool contains pool-specific settings
 * for configuring mirroring.
 */
#define RBD_MIRRORING       "rbd_mirroring"

/**
 * rbd_mirror_leader and rbd_mirror_instance.<instance id> objects are used
 * for pool-level coordination between rbd-mirror daemons.
 */
#define RBD_MIRROR_LEADER               "rbd_mirror_leader"
#define RBD_MIRROR_INSTANCE_PREFIX      "rbd_mirror_instance."

#define RBD_MAX_OBJ_NAME_SIZE	96
#define RBD_MAX_BLOCK_NAME_SIZE 24

/**
 * Maximum string length of the RBD v2 image id (not including
 * null termination). This limit was derived from the existing
 * RBD_MAX_BLOCK_NAME_SIZE limit which needs to hold the "rbd_data."
 * prefix and null termination.
 */
#define RBD_MAX_IMAGE_ID_LENGTH 14

/**
 * Maximum string length of the RBD block object name prefix (not including
 * null termination).
 *
 * v1 format: rb.<max 8-byte high id>.<max 8-byte low id>.<max 8-byte extra>
 * v2 format: rbd_data.[<max 19-byte pool id>.]<max 14-byte image id>
 *
 * Note: new features might require increasing this maximum prefix length.
 */
#define RBD_MAX_BLOCK_NAME_PREFIX_LENGTH 43

#define RBD_COMP_NONE		0
#define RBD_CRYPT_NONE		0

#define RBD_HEADER_TEXT		"<<< Rados Block Device Image >>>\n"
#define RBD_MIGRATE_HEADER_TEXT	"<<< Migrating RBD Image      >>>\n"
#define RBD_HEADER_SIGNATURE	"RBD"
#define RBD_HEADER_VERSION	"001.005"

#define RBD_GROUP_INVALID_POOL (-1)

#define RBD_GROUP_HEADER_PREFIX "rbd_group_header."

#define RBD_GROUP_DIRECTORY "rbd_group_directory"

#define RBD_TRASH "rbd_trash"

/**
 * MON config-key prefix for storing optional remote cluster connectivity
 * parameters
 */
#define RBD_MIRROR_CONFIG_KEY_PREFIX          "rbd/mirror/"
#define RBD_MIRROR_SITE_NAME_CONFIG_KEY       RBD_MIRROR_CONFIG_KEY_PREFIX "site_name"
#define RBD_MIRROR_PEER_CLIENT_ID_CONFIG_KEY  RBD_MIRROR_CONFIG_KEY_PREFIX "peer_client_id"
#define RBD_MIRROR_PEER_CONFIG_KEY_PREFIX     RBD_MIRROR_CONFIG_KEY_PREFIX "peer/"

struct rbd_info {
	ceph_le64 max_id;
} __attribute__ ((packed));

struct rbd_obj_snap_ondisk {
	ceph_le64 id;
	ceph_le64 image_size;
} __attribute__((packed));

struct rbd_obj_header_ondisk {
	char text[40];
	char block_name[RBD_MAX_BLOCK_NAME_SIZE];
	char signature[4];
	char version[8];
	struct {
		__u8 order;
		__u8 crypt_type;
		__u8 comp_type;
		__u8 unused;
	} __attribute__((packed)) options;
	ceph_le64 image_size;
	ceph_le64 snap_seq;
	ceph_le32 snap_count;
	ceph_le32 reserved;
	ceph_le64 snap_names_len;
	struct rbd_obj_snap_ondisk snaps[0];
} __attribute__((packed));

enum {
  RBD_PROTECTION_STATUS_UNPROTECTED  = 0,
  RBD_PROTECTION_STATUS_UNPROTECTING = 1,
  RBD_PROTECTION_STATUS_PROTECTED    = 2,
  RBD_PROTECTION_STATUS_LAST         = 3
};

#endif
Commit	Line	Data
7c673cae FG	1	/*
	2	* Ceph - scalable distributed file system
	3	*
	4	* Copyright (C) 2004-2010 Sage Weil <sage@newdream.net>
	5	*
	6	* This is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU Lesser General Public
	8	* License version 2.1, as published by the Free Software
	9	* Foundation. See file COPYING.
	10	*
	11	*/
	12
	13	#ifndef CEPH_RBD_TYPES_H
	14	#define CEPH_RBD_TYPES_H
	15
	16	#include "include/types.h"
	17	#include "rbd/features.h"
	18
	19	/* New-style rbd image 'foo' consists of objects
	20	* rbd_id.foo - id of image
	21	* rbd_header.<id> - image metadata
	22	* rbd_object_map.<id> - optional image object map
	23	* rbd_data.<id>.00000000
	24	* rbd_data.<id>.00000001
	25	* ... - data
	26	*/
	27
	28	#define RBD_HEADER_PREFIX "rbd_header."
	29	#define RBD_OBJECT_MAP_PREFIX "rbd_object_map."
	30	#define RBD_DATA_PREFIX "rbd_data."
	31	#define RBD_ID_PREFIX "rbd_id."
	32
	33	/*
	34	* old-style rbd image 'foo' consists of objects
	35	* foo.rbd - image metadata
	36	* rb.<idhi>.<idlo>.00000000
	37	* rb.<idhi>.<idlo>.00000001
	38	* ... - data
	39	*/
	40
	41	#define RBD_SUFFIX ".rbd"
	42	#define RBD_DIRECTORY "rbd_directory"
	43	#define RBD_INFO "rbd_info"
11fdf7f2	44	#define RBD_NAMESPACE "rbd_namespace"
494da23a	45	#define RBD_TASK "rbd_task"
7c673cae FG	46
	47	/*
	48	* rbd_children object in each pool contains omap entries
	49	* that map parent (poolid, imageid, snapid) to a list of children
	50	* (imageids; snapids aren't required because we get all the snapshot
	51	* info from a read of the child's header object anyway).
	52	*
	53	* The clone operation writes a new item to this child list, and rm or
	54	* flatten removes an item, and may remove the whole entry if no children
	55	* exist after the rm/flatten.
	56	*
	57	* When attempting to remove a parent, all pools are searched for
	58	* rbd_children objects with entries referring to that parent; if any
	59	* exist (and those children exist), the parent removal is prevented.
	60	*/
	61	#define RBD_CHILDREN "rbd_children"
	62	#define RBD_LOCK_NAME "rbd_lock"
	63
	64	/**
	65	* rbd_mirroring object in each pool contains pool-specific settings
	66	* for configuring mirroring.
	67	*/
	68	#define RBD_MIRRORING "rbd_mirroring"
	69
	70	/**
	71	* rbd_mirror_leader and rbd_mirror_instance.<instance id> objects are used
	72	* for pool-level coordination between rbd-mirror daemons.
	73	*/
	74	#define RBD_MIRROR_LEADER "rbd_mirror_leader"
	75	#define RBD_MIRROR_INSTANCE_PREFIX "rbd_mirror_instance."
	76
	77	#define RBD_MAX_OBJ_NAME_SIZE 96
	78	#define RBD_MAX_BLOCK_NAME_SIZE 24
	79
	80	/**
	81	* Maximum string length of the RBD v2 image id (not including
	82	* null termination). This limit was derived from the existing
	83	* RBD_MAX_BLOCK_NAME_SIZE limit which needs to hold the "rbd_data."
	84	* prefix and null termination.
	85	*/
	86	#define RBD_MAX_IMAGE_ID_LENGTH 14
	87
	88	/**
	89	* Maximum string length of the RBD block object name prefix (not including
	90	* null termination).
	91	*
	92	* v1 format: rb.<max 8-byte high id>.<max 8-byte low id>.<max 8-byte extra>
	93	* v2 format: rbd_data.[<max 19-byte pool id>.]<max 14-byte image id>
	94	*
	95	* Note: new features might require increasing this maximum prefix length.
	96	*/
	97	#define RBD_MAX_BLOCK_NAME_PREFIX_LENGTH 43
	98
	99	#define RBD_COMP_NONE 0
	100	#define RBD_CRYPT_NONE 0
	101
	102	#define RBD_HEADER_TEXT "<<< Rados Block Device Image >>>\n"
11fdf7f2	103	#define RBD_MIGRATE_HEADER_TEXT "<<< Migrating RBD Image >>>\n"
7c673cae FG	104	#define RBD_HEADER_SIGNATURE "RBD"
	105	#define RBD_HEADER_VERSION "001.005"
	106
11fdf7f2 TL	107	#define RBD_GROUP_INVALID_POOL (-1)
11fdf7f2 TL	108
7c673cae FG	109	#define RBD_GROUP_HEADER_PREFIX "rbd_group_header."
	110
	111	#define RBD_GROUP_DIRECTORY "rbd_group_directory"
	112
	113	#define RBD_TRASH "rbd_trash"
	114
11fdf7f2 TL	115	/**
	116	* MON config-key prefix for storing optional remote cluster connectivity
	117	* parameters
	118	*/
eafe8130 TL	119	#define RBD_MIRROR_CONFIG_KEY_PREFIX "rbd/mirror/"
	120	#define RBD_MIRROR_SITE_NAME_CONFIG_KEY RBD_MIRROR_CONFIG_KEY_PREFIX "site_name"
	121	#define RBD_MIRROR_PEER_CLIENT_ID_CONFIG_KEY RBD_MIRROR_CONFIG_KEY_PREFIX "peer_client_id"
	122	#define RBD_MIRROR_PEER_CONFIG_KEY_PREFIX RBD_MIRROR_CONFIG_KEY_PREFIX "peer/"
11fdf7f2	123
7c673cae	124	struct rbd_info {
eafe8130	125	ceph_le64 max_id;
7c673cae FG	126	} __attribute__ ((packed));
	127
	128	struct rbd_obj_snap_ondisk {
eafe8130 TL	129	ceph_le64 id;
eafe8130 TL	130	ceph_le64 image_size;
7c673cae FG	131	} __attribute__((packed));
	132
	133	struct rbd_obj_header_ondisk {
	134	char text[40];
	135	char block_name[RBD_MAX_BLOCK_NAME_SIZE];
	136	char signature[4];
	137	char version[8];
	138	struct {
	139	__u8 order;
	140	__u8 crypt_type;
	141	__u8 comp_type;
	142	__u8 unused;
	143	} __attribute__((packed)) options;
eafe8130 TL	144	ceph_le64 image_size;
	145	ceph_le64 snap_seq;
	146	ceph_le32 snap_count;
	147	ceph_le32 reserved;
	148	ceph_le64 snap_names_len;
7c673cae FG	149	struct rbd_obj_snap_ondisk snaps[0];
	150	} __attribute__((packed));
	151
	152	enum {
	153	RBD_PROTECTION_STATUS_UNPROTECTED = 0,
	154	RBD_PROTECTION_STATUS_UNPROTECTING = 1,
	155	RBD_PROTECTION_STATUS_PROTECTED = 2,
	156	RBD_PROTECTION_STATUS_LAST = 3
	157	};
	158
	159	#endif