1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
// vim: ts=8 sw=2 smarttab
#ifndef __CEPH_CLS_RBD_H
#define __CEPH_CLS_RBD_H
#include "include/types.h"
#include "include/buffer_fwd.h"
#include "include/rbd_types.h"
#include "common/Formatter.h"
#include "cls/rbd/cls_rbd_types.h"
/// information about our parent image, if any
struct cls_rbd_parent {
int64_t pool_id = -1;
std::string pool_namespace;
std::string image_id;
snapid_t snap_id = CEPH_NOSNAP;
std::optional<uint64_t> head_overlap = std::nullopt;
cls_rbd_parent() {
}
cls_rbd_parent(const cls::rbd::ParentImageSpec& parent_image_spec,
const std::optional<uint64_t>& head_overlap)
: pool_id(parent_image_spec.pool_id),
pool_namespace(parent_image_spec.pool_namespace),
image_id(parent_image_spec.image_id), snap_id(parent_image_spec.snap_id),
head_overlap(head_overlap) {
}
inline bool exists() const {
return (pool_id >= 0 && !image_id.empty() && snap_id != CEPH_NOSNAP);
}
inline bool operator==(const cls_rbd_parent& rhs) const {
return (pool_id == rhs.pool_id &&
pool_namespace == rhs.pool_namespace &&
image_id == rhs.image_id &&
snap_id == rhs.snap_id);
}
inline bool operator!=(const cls_rbd_parent& rhs) const {
return !(*this == rhs);
}
void encode(ceph::buffer::list& bl, uint64_t features) const {
// NOTE: remove support for version 1 after Nautilus EOLed
uint8_t version = 1;
if ((features & CEPH_FEATURE_SERVER_NAUTILUS) != 0ULL) {
// break backwards compatability when using nautilus or later OSDs
version = 2;
}
ENCODE_START(version, version, bl);
encode(pool_id, bl);
if (version >= 2) {
encode(pool_namespace, bl);
}
encode(image_id, bl);
encode(snap_id, bl);
if (version == 1) {
encode(head_overlap.value_or(0ULL), bl);
} else {
encode(head_overlap, bl);
}
ENCODE_FINISH(bl);
}
void decode(ceph::buffer::list::const_iterator& bl) {
DECODE_START(2, bl);
decode(pool_id, bl);
if (struct_v >= 2) {
decode(pool_namespace, bl);
}
decode(image_id, bl);
decode(snap_id, bl);
if (struct_v == 1) {
uint64_t overlap;
decode(overlap, bl);
head_overlap = overlap;
} else {
decode(head_overlap, bl);
}
DECODE_FINISH(bl);
}
void dump(ceph::Formatter *f) const {
f->dump_int("pool_id", pool_id);
f->dump_string("pool_namespace", pool_namespace);
f->dump_string("image_id", image_id);
f->dump_unsigned("snap_id", snap_id);
if (head_overlap) {
f->dump_unsigned("head_overlap", *head_overlap);
}
}
static void generate_test_instances(std::list<cls_rbd_parent*>& o) {
o.push_back(new cls_rbd_parent{});
o.push_back(new cls_rbd_parent{{1, "", "image id", 234}, {}});
o.push_back(new cls_rbd_parent{{1, "", "image id", 234}, {123}});
o.push_back(new cls_rbd_parent{{1, "ns", "image id", 234}, {123}});
}
};
WRITE_CLASS_ENCODER_FEATURES(cls_rbd_parent)
struct cls_rbd_snap {
snapid_t id = CEPH_NOSNAP;
std::string name;
uint64_t image_size = 0;
uint8_t protection_status = RBD_PROTECTION_STATUS_UNPROTECTED;
cls_rbd_parent parent;
uint64_t flags = 0;
utime_t timestamp;
cls::rbd::SnapshotNamespace snapshot_namespace = {
cls::rbd::UserSnapshotNamespace{}};
uint32_t child_count = 0;
std::optional<uint64_t> parent_overlap = std::nullopt;
cls_rbd_snap() {
}
cls_rbd_snap(snapid_t id, const std::string& name, uint64_t image_size,
uint8_t protection_status, const cls_rbd_parent& parent,
uint64_t flags, utime_t timestamp,
const cls::rbd::SnapshotNamespace& snapshot_namespace,
uint32_t child_count,
const std::optional<uint64_t>& parent_overlap)
: id(id), name(name), image_size(image_size),
protection_status(protection_status), parent(parent), flags(flags),
timestamp(timestamp), snapshot_namespace(snapshot_namespace),
child_count(child_count), parent_overlap(parent_overlap) {
}
bool migrate_parent_format(uint64_t features) const {
return (((features & CEPH_FEATURE_SERVER_NAUTILUS) != 0) &&
(parent.exists()));
}
void encode(ceph::buffer::list& bl, uint64_t features) const {
// NOTE: remove support for versions < 8 after Nautilus EOLed
uint8_t min_version = 1;
if ((features & CEPH_FEATURE_SERVER_NAUTILUS) != 0ULL) {
// break backwards compatability when using nautilus or later OSDs
min_version = 8;
}
ENCODE_START(8, min_version, bl);
encode(id, bl);
encode(name, bl);
encode(image_size, bl);
if (min_version < 8) {
uint64_t image_features = 0;
encode(image_features, bl); // unused -- preserve ABI
encode(parent, bl, features);
}
encode(protection_status, bl);
encode(flags, bl);
encode(snapshot_namespace, bl);
encode(timestamp, bl);
encode(child_count, bl);
encode(parent_overlap, bl);
ENCODE_FINISH(bl);
}
void decode(ceph::buffer::list::const_iterator& p) {
DECODE_START(8, p);
decode(id, p);
decode(name, p);
decode(image_size, p);
if (struct_compat < 8) {
uint64_t features;
decode(features, p); // unused -- preserve ABI
}
if (struct_v >= 2 && struct_compat < 8) {
decode(parent, p);
}
if (struct_v >= 3) {
decode(protection_status, p);
}
if (struct_v >= 4) {
decode(flags, p);
}
if (struct_v >= 5) {
decode(snapshot_namespace, p);
}
if (struct_v >= 6) {
decode(timestamp, p);
}
if (struct_v >= 7) {
decode(child_count, p);
}
if (struct_v >= 8) {
decode(parent_overlap, p);
}
DECODE_FINISH(p);
}
void dump(ceph::Formatter *f) const {
f->dump_unsigned("id", id);
f->dump_string("name", name);
f->dump_unsigned("image_size", image_size);
if (parent.exists()) {
f->open_object_section("parent");
parent.dump(f);
f->close_section();
}
switch (protection_status) {
case RBD_PROTECTION_STATUS_UNPROTECTED:
f->dump_string("protection_status", "unprotected");
break;
case RBD_PROTECTION_STATUS_UNPROTECTING:
f->dump_string("protection_status", "unprotecting");
break;
case RBD_PROTECTION_STATUS_PROTECTED:
f->dump_string("protection_status", "protected");
break;
default:
ceph_abort();
}
f->open_object_section("namespace");
snapshot_namespace.dump(f);
f->close_section();
f->dump_stream("timestamp") << timestamp;
f->dump_unsigned("child_count", child_count);
if (parent_overlap) {
f->dump_unsigned("parent_overlap", *parent_overlap);
}
}
static void generate_test_instances(std::list<cls_rbd_snap*>& o) {
o.push_back(new cls_rbd_snap{});
o.push_back(new cls_rbd_snap{1, "snap", 123456,
RBD_PROTECTION_STATUS_PROTECTED,
{{1, "", "image", 123}, 234}, 31, {},
cls::rbd::UserSnapshotNamespace{}, 543, {}});
o.push_back(new cls_rbd_snap{1, "snap", 123456,
RBD_PROTECTION_STATUS_PROTECTED,
{{1, "", "image", 123}, 234}, 31, {},
cls::rbd::UserSnapshotNamespace{}, 543, {0}});
o.push_back(new cls_rbd_snap{1, "snap", 123456,
RBD_PROTECTION_STATUS_PROTECTED,
{{1, "ns", "image", 123}, 234}, 31, {},
cls::rbd::UserSnapshotNamespace{}, 543,
{123}});
}
};
WRITE_CLASS_ENCODER_FEATURES(cls_rbd_snap)
#endif // __CEPH_CLS_RBD_H
|
