1 // -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*-
2 // vim: ts=8 sw=2 smarttab
4 #include "tools/rbd/Utils.h"
5 #include "include/ceph_assert.h"
6 #include "include/Context.h"
7 #include "include/encoding.h"
8 #include "common/common_init.h"
9 #include "include/stringify.h"
10 #include "include/rbd/features.h"
11 #include "common/config.h"
12 #include "common/errno.h"
13 #include "common/escape.h"
14 #include "common/safe_io.h"
15 #include "global/global_context.h"
18 #include <boost/algorithm/string.hpp>
19 #include <boost/lexical_cast.hpp>
24 namespace at
= argument_types
;
25 namespace po
= boost::program_options
;
29 static std::string
mgr_command_args_to_str(
30 const std::map
<std::string
, std::string
> &args
) {
33 std::string delimiter
;
34 for (auto &it
: args
) {
35 out
+= delimiter
+ "\"" + it
.first
+ "\": \"" +
36 stringify(json_stream_escaper(it
.second
)) + "\"";
43 } // anonymous namespace
45 int ProgressContext::update_progress(uint64_t offset
, uint64_t total
) {
47 int pc
= get_percentage(offset
, total
);
49 std::cerr
<< "\r" << operation
<< ": "
50 << pc
<< "% complete..." << std::flush
;
57 void ProgressContext::finish() {
59 std::cerr
<< "\r" << operation
<< ": 100% complete...done." << std::endl
;
63 void ProgressContext::fail() {
65 std::cerr
<< "\r" << operation
<< ": " << last_pc
<< "% complete...failed."
70 int get_percentage(uint64_t part
, uint64_t whole
) {
71 return whole
? (100 * part
/ whole
) : 0;
74 void aio_context_callback(librbd::completion_t completion
, void *arg
)
76 librbd::RBD::AioCompletion
*aio_completion
=
77 reinterpret_cast<librbd::RBD::AioCompletion
*>(completion
);
78 Context
*context
= reinterpret_cast<Context
*>(arg
);
79 context
->complete(aio_completion
->get_return_value());
80 aio_completion
->release();
83 int read_string(int fd
, unsigned max
, std::string
*out
) {
86 int r
= safe_read_exact(fd
, buf
, 4);
99 r
= safe_read_exact(fd
, sbuf
, len
);
102 out
->assign(sbuf
, len
);
106 int extract_spec(const std::string
&spec
, std::string
*pool_name
,
107 std::string
*namespace_name
, std::string
*name
,
108 std::string
*snap_name
, SpecValidation spec_validation
) {
109 if (!g_ceph_context
->_conf
.get_val
<bool>("rbd_validate_names")) {
110 spec_validation
= SPEC_VALIDATION_NONE
;
114 switch (spec_validation
) {
115 case SPEC_VALIDATION_FULL
:
116 // disallow "/" and "@" in all names
117 pattern
= "^(?:([^/@]+)/(?:([^/@]+)/)?)?([^/@]+)(?:@([^/@]+))?$";
119 case SPEC_VALIDATION_SNAP
:
120 // disallow "/" and "@" in snap name
121 pattern
= "^(?:([^/]+)/(?:([^/@]+)/)?)?([^@]+)(?:@([^/@]+))?$";
123 case SPEC_VALIDATION_NONE
:
124 // relaxed pattern assumes pool is before first "/",
125 // namespace is before second "/", and snap name is after first "@"
126 pattern
= "^(?:([^/]+)/(?:([^/@]+)/)?)?([^@]+)(?:@(.+))?$";
134 if (!std::regex_match(spec
, match
, pattern
)) {
135 std::cerr
<< "rbd: invalid spec '" << spec
<< "'" << std::endl
;
139 if (match
[1].matched
) {
140 if (pool_name
!= nullptr) {
141 *pool_name
= match
[1];
143 std::cerr
<< "rbd: pool name specified for a command that doesn't use it"
149 if (match
[2].matched
) {
150 if (namespace_name
!= nullptr) {
151 *namespace_name
= match
[2];
153 std::cerr
<< "rbd: namespace name specified for a command that doesn't "
154 << "use it" << std::endl
;
159 if (name
!= nullptr) {
163 if (match
[4].matched
) {
164 if (snap_name
!= nullptr) {
165 *snap_name
= match
[4];
167 std::cerr
<< "rbd: snapshot name specified for a command that doesn't "
168 << "use it" << std::endl
;
175 std::string
get_positional_argument(const po::variables_map
&vm
, size_t index
) {
176 if (vm
.count(at::POSITIONAL_ARGUMENTS
) == 0) {
180 const std::vector
<std::string
> &args
=
181 boost::any_cast
<std::vector
<std::string
> >(
182 vm
[at::POSITIONAL_ARGUMENTS
].value());
183 if (index
< args
.size()) {
189 void normalize_pool_name(std::string
* pool_name
) {
190 if (pool_name
->empty()) {
191 *pool_name
= get_default_pool_name();
195 std::string
get_default_pool_name() {
196 return g_ceph_context
->_conf
.get_val
<std::string
>("rbd_default_pool");
199 int get_pool_and_namespace_names(
200 const boost::program_options::variables_map
&vm
,
201 bool default_empty_pool_name
, bool validate_pool_name
,
202 std::string
* pool_name
, std::string
* namespace_name
, size_t *arg_index
) {
203 if (namespace_name
!= nullptr && vm
.count(at::NAMESPACE_NAME
)) {
204 *namespace_name
= vm
[at::NAMESPACE_NAME
].as
<std::string
>();
207 if (vm
.count(at::POOL_NAME
)) {
208 *pool_name
= vm
[at::POOL_NAME
].as
<std::string
>();
210 *pool_name
= get_positional_argument(vm
, *arg_index
);
211 if (!pool_name
->empty()) {
212 if (namespace_name
!= nullptr) {
213 auto slash_pos
= pool_name
->find_last_of('/');
214 if (slash_pos
!= std::string::npos
) {
215 *namespace_name
= pool_name
->substr(slash_pos
+ 1);
217 *pool_name
= pool_name
->substr(0, slash_pos
);
223 if (!g_ceph_context
->_conf
.get_val
<bool>("rbd_validate_names")) {
224 validate_pool_name
= false;
227 if (validate_pool_name
&&
228 pool_name
->find_first_of("/@") != std::string::npos
) {
229 std::cerr
<< "rbd: invalid pool '" << *pool_name
<< "'" << std::endl
;
231 } else if (namespace_name
!= nullptr &&
232 namespace_name
->find_first_of("/@") != std::string::npos
) {
233 std::cerr
<< "rbd: invalid namespace '" << *namespace_name
<< "'"
241 int get_pool_image_id(const po::variables_map
&vm
,
242 size_t *spec_arg_index
,
243 std::string
*pool_name
,
244 std::string
*namespace_name
,
245 std::string
*image_id
) {
247 if (vm
.count(at::POOL_NAME
) && pool_name
!= nullptr) {
248 *pool_name
= vm
[at::POOL_NAME
].as
<std::string
>();
250 if (vm
.count(at::NAMESPACE_NAME
) && namespace_name
!= nullptr) {
251 *namespace_name
= vm
[at::NAMESPACE_NAME
].as
<std::string
>();
253 if (vm
.count(at::IMAGE_ID
) && image_id
!= nullptr) {
254 *image_id
= vm
[at::IMAGE_ID
].as
<std::string
>();
258 if (image_id
!= nullptr && spec_arg_index
!= nullptr && image_id
->empty()) {
259 std::string spec
= get_positional_argument(vm
, (*spec_arg_index
)++);
261 r
= extract_spec(spec
, pool_name
, namespace_name
, image_id
, nullptr,
262 SPEC_VALIDATION_FULL
);
269 if (image_id
!= nullptr && image_id
->empty()) {
270 std::cerr
<< "rbd: image id was not specified" << std::endl
;
277 int get_pool_image_snapshot_names(const po::variables_map
&vm
,
278 at::ArgumentModifier mod
,
279 size_t *spec_arg_index
,
280 std::string
*pool_name
,
281 std::string
*namespace_name
,
282 std::string
*image_name
,
283 std::string
*snap_name
,
284 bool image_name_required
,
285 SnapshotPresence snapshot_presence
,
286 SpecValidation spec_validation
) {
287 std::string pool_key
= (mod
== at::ARGUMENT_MODIFIER_DEST
?
288 at::DEST_POOL_NAME
: at::POOL_NAME
);
289 std::string image_key
= (mod
== at::ARGUMENT_MODIFIER_DEST
?
290 at::DEST_IMAGE_NAME
: at::IMAGE_NAME
);
291 return get_pool_generic_snapshot_names(vm
, mod
, spec_arg_index
, pool_key
,
292 pool_name
, namespace_name
, image_key
,
293 "image", image_name
, snap_name
,
294 image_name_required
, snapshot_presence
,
298 int get_pool_generic_snapshot_names(const po::variables_map
&vm
,
299 at::ArgumentModifier mod
,
300 size_t *spec_arg_index
,
301 const std::string
& pool_key
,
302 std::string
*pool_name
,
303 std::string
*namespace_name
,
304 const std::string
& generic_key
,
305 const std::string
& generic_key_desc
,
306 std::string
*generic_name
,
307 std::string
*snap_name
,
308 bool generic_name_required
,
309 SnapshotPresence snapshot_presence
,
310 SpecValidation spec_validation
) {
311 std::string namespace_key
= (mod
== at::ARGUMENT_MODIFIER_DEST
?
312 at::DEST_NAMESPACE_NAME
: at::NAMESPACE_NAME
);
313 std::string snap_key
= (mod
== at::ARGUMENT_MODIFIER_DEST
?
314 at::DEST_SNAPSHOT_NAME
: at::SNAPSHOT_NAME
);
316 if (vm
.count(pool_key
) && pool_name
!= nullptr) {
317 *pool_name
= vm
[pool_key
].as
<std::string
>();
319 if (vm
.count(namespace_key
) && namespace_name
!= nullptr) {
320 *namespace_name
= vm
[namespace_key
].as
<std::string
>();
322 if (vm
.count(generic_key
) && generic_name
!= nullptr) {
323 *generic_name
= vm
[generic_key
].as
<std::string
>();
325 if (vm
.count(snap_key
) && snap_name
!= nullptr) {
326 *snap_name
= vm
[snap_key
].as
<std::string
>();
330 if ((generic_key
== at::IMAGE_NAME
|| generic_key
== at::DEST_IMAGE_NAME
) &&
331 generic_name
!= nullptr && !generic_name
->empty()) {
332 // despite the separate pool and snapshot name options,
333 // we can also specify them via the image option
334 std::string
image_name_copy(*generic_name
);
335 r
= extract_spec(image_name_copy
, pool_name
, namespace_name
, generic_name
,
336 snap_name
, spec_validation
);
342 if (generic_name
!= nullptr && spec_arg_index
!= nullptr &&
343 generic_name
->empty()) {
344 std::string spec
= get_positional_argument(vm
, (*spec_arg_index
)++);
346 r
= extract_spec(spec
, pool_name
, namespace_name
, generic_name
, snap_name
,
354 if (generic_name
!= nullptr && generic_name_required
&&
355 generic_name
->empty()) {
356 std::string prefix
= at::get_description_prefix(mod
);
358 << (mod
== at::ARGUMENT_MODIFIER_DEST
? prefix
: std::string())
359 << generic_key_desc
<< " name was not specified" << std::endl
;
363 std::regex
pattern("^[^@/]*?$");
364 if (spec_validation
== SPEC_VALIDATION_FULL
) {
365 // validate pool name while creating/renaming/copying/cloning/importing/etc
366 if ((pool_name
!= nullptr) && !std::regex_match (*pool_name
, pattern
)) {
367 std::cerr
<< "rbd: invalid pool name '" << *pool_name
<< "'" << std::endl
;
372 if (namespace_name
!= nullptr && !namespace_name
->empty() &&
373 !std::regex_match (*namespace_name
, pattern
)) {
374 std::cerr
<< "rbd: invalid namespace name '" << *namespace_name
<< "'"
379 if (snap_name
!= nullptr) {
380 r
= validate_snapshot_name(mod
, *snap_name
, snapshot_presence
,
389 int validate_snapshot_name(at::ArgumentModifier mod
,
390 const std::string
&snap_name
,
391 SnapshotPresence snapshot_presence
,
392 SpecValidation spec_validation
) {
393 std::string prefix
= at::get_description_prefix(mod
);
394 switch (snapshot_presence
) {
395 case SNAPSHOT_PRESENCE_PERMITTED
:
397 case SNAPSHOT_PRESENCE_NONE
:
398 if (!snap_name
.empty()) {
400 << (mod
== at::ARGUMENT_MODIFIER_DEST
? prefix
: std::string())
401 << "snapshot name specified for a command that doesn't use it"
406 case SNAPSHOT_PRESENCE_REQUIRED
:
407 if (snap_name
.empty()) {
409 << (mod
== at::ARGUMENT_MODIFIER_DEST
? prefix
: std::string())
410 << "snapshot name was not specified" << std::endl
;
416 if (spec_validation
== SPEC_VALIDATION_SNAP
) {
417 // disallow "/" and "@" in snap name
418 std::regex
pattern("^[^@/]*?$");
419 if (!std::regex_match (snap_name
, pattern
)) {
420 std::cerr
<< "rbd: invalid snap name '" << snap_name
<< "'" << std::endl
;
427 int get_image_options(const boost::program_options::variables_map
&vm
,
428 bool get_format
, librbd::ImageOptions
*opts
) {
429 uint64_t order
= 0, stripe_unit
= 0, stripe_count
= 0, object_size
= 0;
430 uint64_t features
= 0, features_clear
= 0;
431 std::string data_pool
;
432 bool order_specified
= true;
433 bool features_specified
= false;
434 bool features_clear_specified
= false;
435 bool stripe_specified
= false;
437 if (vm
.count(at::IMAGE_ORDER
)) {
438 order
= vm
[at::IMAGE_ORDER
].as
<uint64_t>();
439 } else if (vm
.count(at::IMAGE_OBJECT_SIZE
)) {
440 object_size
= vm
[at::IMAGE_OBJECT_SIZE
].as
<uint64_t>();
441 order
= std::round(std::log2(object_size
));
443 order_specified
= false;
446 if (vm
.count(at::IMAGE_FEATURES
)) {
447 features
= vm
[at::IMAGE_FEATURES
].as
<uint64_t>();
448 features_specified
= true;
451 if (vm
.count(at::IMAGE_STRIPE_UNIT
)) {
452 stripe_unit
= vm
[at::IMAGE_STRIPE_UNIT
].as
<uint64_t>();
453 stripe_specified
= true;
456 if (vm
.count(at::IMAGE_STRIPE_COUNT
)) {
457 stripe_count
= vm
[at::IMAGE_STRIPE_COUNT
].as
<uint64_t>();
458 stripe_specified
= true;
461 if (vm
.count(at::IMAGE_SHARED
) && vm
[at::IMAGE_SHARED
].as
<bool>()) {
462 if (features_specified
) {
463 features
&= ~RBD_FEATURES_SINGLE_CLIENT
;
465 features_clear
|= RBD_FEATURES_SINGLE_CLIENT
;
466 features_clear_specified
= true;
470 if (vm
.count(at::IMAGE_DATA_POOL
)) {
471 data_pool
= vm
[at::IMAGE_DATA_POOL
].as
<std::string
>();
476 bool format_specified
= false;
477 if (vm
.count(at::IMAGE_NEW_FORMAT
)) {
479 format_specified
= true;
480 } else if (vm
.count(at::IMAGE_FORMAT
)) {
481 format
= vm
[at::IMAGE_FORMAT
].as
<uint32_t>();
482 format_specified
= true;
485 std::cerr
<< "rbd: image format 1 is deprecated" << std::endl
;
488 if (features_specified
&& features
!= 0) {
489 if (format_specified
&& format
== 1) {
490 std::cerr
<< "rbd: features not allowed with format 1; "
491 << "use --image-format 2" << std::endl
;
495 format_specified
= true;
499 if ((stripe_unit
|| stripe_count
) &&
500 (stripe_unit
!= (1ull << order
) && stripe_count
!= 1)) {
501 if (format_specified
&& format
== 1) {
502 std::cerr
<< "rbd: non-default striping not allowed with format 1; "
503 << "use --image-format 2" << std::endl
;
507 format_specified
= true;
511 if (!data_pool
.empty()) {
512 if (format_specified
&& format
== 1) {
513 std::cerr
<< "rbd: data pool not allowed with format 1; "
514 << "use --image-format 2" << std::endl
;
518 format_specified
= true;
522 if (format_specified
) {
523 int r
= g_conf().set_val("rbd_default_format", stringify(format
));
525 opts
->set(RBD_IMAGE_OPTION_FORMAT
, format
);
530 opts
->set(RBD_IMAGE_OPTION_ORDER
, order
);
531 if (features_specified
)
532 opts
->set(RBD_IMAGE_OPTION_FEATURES
, features
);
533 if (features_clear_specified
) {
534 opts
->set(RBD_IMAGE_OPTION_FEATURES_CLEAR
, features_clear
);
536 if (stripe_specified
) {
537 opts
->set(RBD_IMAGE_OPTION_STRIPE_UNIT
, stripe_unit
);
538 opts
->set(RBD_IMAGE_OPTION_STRIPE_COUNT
, stripe_count
);
540 if (!data_pool
.empty()) {
541 opts
->set(RBD_IMAGE_OPTION_DATA_POOL
, data_pool
);
543 int r
= get_journal_options(vm
, opts
);
548 r
= get_flatten_option(vm
, opts
);
553 if (vm
.count(at::IMAGE_MIRROR_IMAGE_MODE
)) {
554 opts
->set(RBD_IMAGE_OPTION_MIRROR_IMAGE_MODE
,
555 vm
[at::IMAGE_MIRROR_IMAGE_MODE
].as
<librbd::mirror_image_mode_t
>());
561 int get_journal_options(const boost::program_options::variables_map
&vm
,
562 librbd::ImageOptions
*opts
) {
564 if (vm
.count(at::JOURNAL_OBJECT_SIZE
)) {
565 uint64_t size
= vm
[at::JOURNAL_OBJECT_SIZE
].as
<uint64_t>();
567 while ((1ULL << order
) < size
) {
570 opts
->set(RBD_IMAGE_OPTION_JOURNAL_ORDER
, order
);
572 int r
= g_conf().set_val("rbd_journal_order", stringify(order
));
575 if (vm
.count(at::JOURNAL_SPLAY_WIDTH
)) {
576 opts
->set(RBD_IMAGE_OPTION_JOURNAL_SPLAY_WIDTH
,
577 vm
[at::JOURNAL_SPLAY_WIDTH
].as
<uint64_t>());
579 int r
= g_conf().set_val("rbd_journal_splay_width",
581 vm
[at::JOURNAL_SPLAY_WIDTH
].as
<uint64_t>()));
584 if (vm
.count(at::JOURNAL_POOL
)) {
585 opts
->set(RBD_IMAGE_OPTION_JOURNAL_POOL
,
586 vm
[at::JOURNAL_POOL
].as
<std::string
>());
588 int r
= g_conf().set_val("rbd_journal_pool",
589 vm
[at::JOURNAL_POOL
].as
<std::string
>());
596 int get_flatten_option(const boost::program_options::variables_map
&vm
,
597 librbd::ImageOptions
*opts
) {
598 if (vm
.count(at::IMAGE_FLATTEN
) && vm
[at::IMAGE_FLATTEN
].as
<bool>()) {
599 uint64_t flatten
= 1;
600 opts
->set(RBD_IMAGE_OPTION_FLATTEN
, flatten
);
605 int get_image_size(const boost::program_options::variables_map
&vm
,
607 if (vm
.count(at::IMAGE_SIZE
) == 0) {
608 std::cerr
<< "rbd: must specify --size <M/G/T>" << std::endl
;
612 *size
= vm
[at::IMAGE_SIZE
].as
<uint64_t>();
616 int get_path(const boost::program_options::variables_map
&vm
,
617 size_t *arg_index
, std::string
*path
) {
618 if (vm
.count(at::PATH
)) {
619 *path
= vm
[at::PATH
].as
<std::string
>();
621 *path
= get_positional_argument(vm
, *arg_index
);
622 if (!path
->empty()) {
628 std::cerr
<< "rbd: path was not specified" << std::endl
;
634 int get_formatter(const po::variables_map
&vm
,
635 at::Format::Formatter
*formatter
) {
636 if (vm
.count(at::FORMAT
)) {
637 bool pretty
= vm
[at::PRETTY_FORMAT
].as
<bool>();
638 *formatter
= vm
[at::FORMAT
].as
<at::Format
>().create_formatter(pretty
);
639 if (*formatter
== nullptr && pretty
) {
640 std::cerr
<< "rbd: --pretty-format only works when --format "
641 << "is json or xml" << std::endl
;
643 } else if (*formatter
!= nullptr && !pretty
) {
644 formatter
->get()->enable_line_break();
646 } else if (vm
[at::PRETTY_FORMAT
].as
<bool>()) {
647 std::cerr
<< "rbd: --pretty-format only works when --format "
648 << "is json or xml" << std::endl
;
654 int get_snap_create_flags(const po::variables_map
&vm
, uint32_t *flags
) {
655 if (vm
[at::SKIP_QUIESCE
].as
<bool>() &&
656 vm
[at::IGNORE_QUIESCE_ERROR
].as
<bool>()) {
657 std::cerr
<< "rbd: " << at::IGNORE_QUIESCE_ERROR
658 << " cannot be used together with " << at::SKIP_QUIESCE
664 if (vm
[at::SKIP_QUIESCE
].as
<bool>()) {
665 *flags
|= RBD_SNAP_CREATE_SKIP_QUIESCE
;
666 } else if (vm
[at::IGNORE_QUIESCE_ERROR
].as
<bool>()) {
667 *flags
|= RBD_SNAP_CREATE_IGNORE_QUIESCE_ERROR
;
672 void init_context() {
673 g_conf().set_val_or_die("rbd_cache_writethrough_until_flush", "false");
674 g_conf().apply_changes(nullptr);
677 int init_rados(librados::Rados
*rados
) {
680 int r
= rados
->init_with_context(g_ceph_context
);
682 std::cerr
<< "rbd: couldn't initialize rados!" << std::endl
;
686 r
= rados
->connect();
688 std::cerr
<< "rbd: couldn't connect to the cluster!" << std::endl
;
695 int init(const std::string
&pool_name
, const std::string
& namespace_name
,
696 librados::Rados
*rados
, librados::IoCtx
*io_ctx
) {
699 int r
= init_rados(rados
);
704 r
= init_io_ctx(*rados
, pool_name
, namespace_name
, io_ctx
);
711 int init_io_ctx(librados::Rados
&rados
, std::string pool_name
,
712 const std::string
& namespace_name
, librados::IoCtx
*io_ctx
) {
713 normalize_pool_name(&pool_name
);
715 int r
= rados
.ioctx_create(pool_name
.c_str(), *io_ctx
);
717 if (r
== -ENOENT
&& pool_name
== get_default_pool_name()) {
718 std::cerr
<< "rbd: error opening default pool "
719 << "'" << pool_name
<< "'" << std::endl
720 << "Ensure that the default pool has been created or specify "
721 << "an alternate pool name." << std::endl
;
723 std::cerr
<< "rbd: error opening pool '" << pool_name
<< "': "
724 << cpp_strerror(r
) << std::endl
;
729 return set_namespace(namespace_name
, io_ctx
);
732 int set_namespace(const std::string
& namespace_name
, librados::IoCtx
*io_ctx
) {
733 if (!namespace_name
.empty()) {
736 int r
= rbd
.namespace_exists(*io_ctx
, namespace_name
.c_str(), &exists
);
738 std::cerr
<< "rbd: error asserting namespace: "
739 << cpp_strerror(r
) << std::endl
;
743 std::cerr
<< "rbd: namespace '" << namespace_name
<< "' does not exist."
748 io_ctx
->set_namespace(namespace_name
);
752 void disable_cache() {
753 g_conf().set_val_or_die("rbd_cache", "false");
756 int open_image(librados::IoCtx
&io_ctx
, const std::string
&image_name
,
757 bool read_only
, librbd::Image
*image
) {
761 r
= rbd
.open_read_only(io_ctx
, *image
, image_name
.c_str(), NULL
);
763 r
= rbd
.open(io_ctx
, *image
, image_name
.c_str());
767 std::cerr
<< "rbd: error opening image " << image_name
<< ": "
768 << cpp_strerror(r
) << std::endl
;
774 int open_image_by_id(librados::IoCtx
&io_ctx
, const std::string
&image_id
,
775 bool read_only
, librbd::Image
*image
) {
779 r
= rbd
.open_by_id_read_only(io_ctx
, *image
, image_id
.c_str(), NULL
);
781 r
= rbd
.open_by_id(io_ctx
, *image
, image_id
.c_str());
785 std::cerr
<< "rbd: error opening image with id " << image_id
<< ": "
786 << cpp_strerror(r
) << std::endl
;
792 int init_and_open_image(const std::string
&pool_name
,
793 const std::string
&namespace_name
,
794 const std::string
&image_name
,
795 const std::string
&image_id
,
796 const std::string
&snap_name
, bool read_only
,
797 librados::Rados
*rados
, librados::IoCtx
*io_ctx
,
798 librbd::Image
*image
) {
799 int r
= init(pool_name
, namespace_name
, rados
, io_ctx
);
804 if (image_id
.empty()) {
805 r
= open_image(*io_ctx
, image_name
, read_only
, image
);
807 r
= open_image_by_id(*io_ctx
, image_id
, read_only
, image
);
813 if (!snap_name
.empty()) {
814 r
= snap_set(*image
, snap_name
);
822 int snap_set(librbd::Image
&image
, const std::string
&snap_name
) {
823 int r
= image
.snap_set(snap_name
.c_str());
825 std::cerr
<< "error setting snapshot context: " << cpp_strerror(r
)
832 void calc_sparse_extent(const bufferptr
&bp
,
834 size_t buffer_offset
,
835 uint64_t buffer_length
,
836 size_t *write_length
,
838 if (sparse_size
== 0) {
839 // sparse writes are disabled -- write the full extent
840 ceph_assert(buffer_offset
== 0);
841 *write_length
= buffer_length
;
847 size_t original_offset
= buffer_offset
;
848 while (buffer_offset
< buffer_length
) {
849 size_t extent_size
= std::min
<size_t>(
850 sparse_size
, buffer_length
- buffer_offset
);
852 bufferptr
extent(bp
, buffer_offset
, extent_size
);
854 bool extent_is_zero
= extent
.is_zero();
855 if (original_offset
== buffer_offset
) {
856 *zeroed
= extent_is_zero
;
857 } else if (*zeroed
!= extent_is_zero
) {
858 ceph_assert(*write_length
> 0);
862 buffer_offset
+= extent_size
;
863 *write_length
+= extent_size
;
867 std::string
image_id(librbd::Image
& image
) {
869 int r
= image
.get_id(&id
);
871 return std::string();
876 std::string
mirror_image_mode(librbd::mirror_image_mode_t mode
) {
878 case RBD_MIRROR_IMAGE_MODE_JOURNAL
:
880 case RBD_MIRROR_IMAGE_MODE_SNAPSHOT
:
887 std::string
mirror_image_state(librbd::mirror_image_state_t state
) {
889 case RBD_MIRROR_IMAGE_DISABLING
:
891 case RBD_MIRROR_IMAGE_ENABLED
:
893 case RBD_MIRROR_IMAGE_DISABLED
:
900 std::string
mirror_image_status_state(
901 librbd::mirror_image_status_state_t state
) {
903 case MIRROR_IMAGE_STATUS_STATE_UNKNOWN
:
905 case MIRROR_IMAGE_STATUS_STATE_ERROR
:
907 case MIRROR_IMAGE_STATUS_STATE_SYNCING
:
909 case MIRROR_IMAGE_STATUS_STATE_STARTING_REPLAY
:
910 return "starting_replay";
911 case MIRROR_IMAGE_STATUS_STATE_REPLAYING
:
913 case MIRROR_IMAGE_STATUS_STATE_STOPPING_REPLAY
:
914 return "stopping_replay";
915 case MIRROR_IMAGE_STATUS_STATE_STOPPED
:
918 return "unknown (" + stringify(static_cast<uint32_t>(state
)) + ")";
922 std::string
mirror_image_site_status_state(
923 const librbd::mirror_image_site_status_t
& status
) {
924 return (status
.up
? "up+" : "down+") +
925 mirror_image_status_state(status
.state
);
928 std::string
mirror_image_global_status_state(
929 const librbd::mirror_image_global_status_t
& status
) {
930 librbd::mirror_image_site_status_t local_status
;
931 int r
= get_local_mirror_image_status(status
, &local_status
);
933 return "down+unknown";
936 return mirror_image_site_status_state(local_status
);
939 int get_local_mirror_image_status(
940 const librbd::mirror_image_global_status_t
& status
,
941 librbd::mirror_image_site_status_t
* local_status
) {
942 auto it
= std::find_if(status
.site_statuses
.begin(),
943 status
.site_statuses
.end(),
944 [](auto& site_status
) {
945 return (site_status
.mirror_uuid
==
946 RBD_MIRROR_IMAGE_STATUS_LOCAL_MIRROR_UUID
);
948 if (it
== status
.site_statuses
.end()) {
956 std::string
timestr(time_t t
) {
963 localtime_r(&t
, &tm
);
966 strftime(buf
, sizeof(buf
), "%Y-%m-%d %H:%M:%S", &tm
);
971 uint64_t get_rbd_default_features(CephContext
* cct
) {
972 auto features
= cct
->_conf
.get_val
<std::string
>("rbd_default_features");
973 return boost::lexical_cast
<uint64_t>(features
);
976 bool is_not_user_snap_namespace(librbd::Image
* image
,
977 const librbd::snap_info_t
&snap_info
)
979 librbd::snap_namespace_type_t namespace_type
;
980 int r
= image
->snap_get_namespace_type(snap_info
.id
, &namespace_type
);
984 return namespace_type
!= RBD_SNAP_NAMESPACE_TYPE_USER
;
987 void get_mirror_peer_sites(
988 librados::IoCtx
& io_ctx
,
989 std::vector
<librbd::mirror_peer_site_t
>* mirror_peers
) {
990 librados::IoCtx default_io_ctx
;
991 default_io_ctx
.dup(io_ctx
);
992 default_io_ctx
.set_namespace("");
994 mirror_peers
->clear();
997 int r
= rbd
.mirror_peer_site_list(default_io_ctx
, mirror_peers
);
998 if (r
< 0 && r
!= -ENOENT
) {
999 std::cerr
<< "rbd: failed to list mirror peers" << std::endl
;
1003 void get_mirror_peer_mirror_uuids_to_names(
1004 const std::vector
<librbd::mirror_peer_site_t
>& mirror_peers
,
1005 std::map
<std::string
, std::string
>* mirror_uuids_to_name
) {
1006 mirror_uuids_to_name
->clear();
1007 for (auto& peer
: mirror_peers
) {
1008 if (!peer
.mirror_uuid
.empty() && !peer
.site_name
.empty()) {
1009 (*mirror_uuids_to_name
)[peer
.mirror_uuid
] = peer
.site_name
;
1014 void populate_unknown_mirror_image_site_statuses(
1015 const std::vector
<librbd::mirror_peer_site_t
>& mirror_peers
,
1016 librbd::mirror_image_global_status_t
* global_status
) {
1017 std::set
<std::string
> missing_mirror_uuids
;
1018 librbd::mirror_peer_direction_t mirror_peer_direction
=
1019 RBD_MIRROR_PEER_DIRECTION_RX_TX
;
1020 for (auto& peer
: mirror_peers
) {
1021 if (peer
.uuid
== mirror_peers
.begin()->uuid
) {
1022 mirror_peer_direction
= peer
.direction
;
1023 } else if (mirror_peer_direction
!= RBD_MIRROR_PEER_DIRECTION_RX_TX
&&
1024 mirror_peer_direction
!= peer
.direction
) {
1025 mirror_peer_direction
= RBD_MIRROR_PEER_DIRECTION_RX_TX
;
1028 if (!peer
.mirror_uuid
.empty() &&
1029 peer
.direction
!= RBD_MIRROR_PEER_DIRECTION_TX
) {
1030 missing_mirror_uuids
.insert(peer
.mirror_uuid
);
1034 if (mirror_peer_direction
!= RBD_MIRROR_PEER_DIRECTION_TX
) {
1035 missing_mirror_uuids
.insert(RBD_MIRROR_IMAGE_STATUS_LOCAL_MIRROR_UUID
);
1038 std::vector
<librbd::mirror_image_site_status_t
> site_statuses
;
1039 site_statuses
.reserve(missing_mirror_uuids
.size());
1041 for (auto& site_status
: global_status
->site_statuses
) {
1042 if (missing_mirror_uuids
.count(site_status
.mirror_uuid
) > 0) {
1043 missing_mirror_uuids
.erase(site_status
.mirror_uuid
);
1044 site_statuses
.push_back(site_status
);
1048 for (auto& mirror_uuid
: missing_mirror_uuids
) {
1049 site_statuses
.push_back({mirror_uuid
, MIRROR_IMAGE_STATUS_STATE_UNKNOWN
,
1050 "status not found", 0, false});
1053 std::swap(global_status
->site_statuses
, site_statuses
);
1056 int mgr_command(librados::Rados
& rados
, const std::string
& cmd
,
1057 const std::map
<std::string
, std::string
> &args
,
1058 std::ostream
*out_os
, std::ostream
*err_os
) {
1059 std::string command
= R
"(
1061 "prefix
": ")" + cmd + R"(", )" + mgr_command_args_to_str(args
) + R
"(
1067 int r
= rados
.mgr_command(command
, in_bl
, &out_bl
, &outs
);
1069 (*err_os
) << "rbd: " << cmd
<< " failed: " << cpp_strerror(r
);
1070 if (!outs
.empty()) {
1071 (*err_os
) << ": " << outs
;
1073 (*err_os
) << std::endl
;
1077 if (out_bl
.length() != 0) {
1078 (*out_os
) << out_bl
.c_str();
1084 } // namespace utils