xref: /linux-6.15/drivers/block/rbd_types.h (revision 24dca799)
1 /*
2  * Ceph - scalable distributed file system
3  *
4  * Copyright (C) 2004-2010 Sage Weil <[email protected]>
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 <linux/types.h>
17 
18 /* For format version 2, rbd image 'foo' consists of objects
19  *   rbd_id.foo		- id of image
20  *   rbd_header.<id>	- image metadata
21  *   rbd_data.<id>.0000000000000000
22  *   rbd_data.<id>.0000000000000001
23  *   ...		- data
24  * Clients do not access header data directly in rbd format 2.
25  */
26 
27 #define RBD_HEADER_PREFIX      "rbd_header."
28 #define RBD_DATA_PREFIX        "rbd_data."
29 #define RBD_ID_PREFIX          "rbd_id."
30 
31 #define RBD_LOCK_NAME          "rbd_lock"
32 #define RBD_LOCK_TAG           "internal"
33 #define RBD_LOCK_COOKIE_PREFIX "auto"
34 
35 enum rbd_notify_op {
36 	RBD_NOTIFY_OP_ACQUIRED_LOCK      = 0,
37 	RBD_NOTIFY_OP_RELEASED_LOCK      = 1,
38 	RBD_NOTIFY_OP_REQUEST_LOCK       = 2,
39 	RBD_NOTIFY_OP_HEADER_UPDATE      = 3,
40 };
41 
42 /*
43  * For format version 1, rbd image 'foo' consists of objects
44  *   foo.rbd		- image metadata
45  *   rb.<idhi>.<idlo>.00000000
46  *   rb.<idhi>.<idlo>.00000001
47  *   ...		- data
48  * There is no notion of a persistent image id in rbd format 1.
49  */
50 
51 #define RBD_SUFFIX		".rbd"
52 
53 #define RBD_DIRECTORY           "rbd_directory"
54 #define RBD_INFO                "rbd_info"
55 
56 #define RBD_DEFAULT_OBJ_ORDER	22   /* 4MB */
57 #define RBD_MIN_OBJ_ORDER       16
58 #define RBD_MAX_OBJ_ORDER       30
59 
60 #define RBD_HEADER_TEXT		"<<< Rados Block Device Image >>>\n"
61 #define RBD_HEADER_SIGNATURE	"RBD"
62 #define RBD_HEADER_VERSION	"001.005"
63 
64 struct rbd_image_snap_ondisk {
65 	__le64 id;
66 	__le64 image_size;
67 } __attribute__((packed));
68 
69 struct rbd_image_header_ondisk {
70 	char text[40];
71 	char object_prefix[24];
72 	char signature[4];
73 	char version[8];
74 	struct {
75 		__u8 order;
76 		__u8 crypt_type;
77 		__u8 comp_type;
78 		__u8 unused;
79 	} __attribute__((packed)) options;
80 	__le64 image_size;
81 	__le64 snap_seq;
82 	__le32 snap_count;
83 	__le32 reserved;
84 	__le64 snap_names_len;
85 	struct rbd_image_snap_ondisk snaps[0];
86 } __attribute__((packed));
87 
88 
89 #endif
90