diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:45:59 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:45:59 +0000 |
commit | 19fcec84d8d7d21e796c7624e521b60d28ee21ed (patch) | |
tree | 42d26aa27d1e3f7c0b8bd3fd14e7d7082f5008dc /src/rbd_replay/rbd_loc.hpp | |
parent | Initial commit. (diff) | |
download | ceph-19fcec84d8d7d21e796c7624e521b60d28ee21ed.tar.xz ceph-19fcec84d8d7d21e796c7624e521b60d28ee21ed.zip |
Adding upstream version 16.2.11+ds.upstream/16.2.11+dsupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/rbd_replay/rbd_loc.hpp')
-rw-r--r-- | src/rbd_replay/rbd_loc.hpp | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/src/rbd_replay/rbd_loc.hpp b/src/rbd_replay/rbd_loc.hpp new file mode 100644 index 000000000..8b7bfac1f --- /dev/null +++ b/src/rbd_replay/rbd_loc.hpp @@ -0,0 +1,90 @@ +// -*- mode:C++; tab-width:8; c-basic-offset:2; indent-tabs-mode:t -*- +// vim: ts=8 sw=2 smarttab +/* + * Ceph - scalable distributed file system + * + * Copyright (C) 2014 Adam Crume <adamcrume@gmail.com> + * + * 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 _INCLUDED_RBD_REPLAY_RBD_LOC_HPP +#define _INCLUDED_RBD_REPLAY_RBD_LOC_HPP + +#include <string> + +namespace rbd_replay { + +/** + Stores a pool, image name, and snap name triple. + rbd_locs can be converted to/from strings with the format pool/image\@snap. + The slash and at signs can be omitted if the pool and snap are empty, respectively. + Backslashes can be used to escape slashes and at signs in names. + Examples: + + |Pool | Image | Snap | String | + |------|-------|------|--------------------| + |rbd | vm | 1 | rbd/vm\@1 | + |rbd | vm | | rbd/vm | + | | vm | 1 | vm\@1 | + | | vm | | vm | + |rbd | | 1 | rbd/\@1 | + |rbd\@x| vm/y | 1 | rbd\\\@x/vm\\/y\@1 | + + (The empty string should obviously be avoided as the image name.) + + Note that the non-canonical forms /vm\@1 and rbd/vm\@ can also be parsed, + although they will be formatted as vm\@1 and rbd/vm. + */ +struct rbd_loc { + /** + Constructs an rbd_loc with the empty string for the pool, image, and snap. + */ + rbd_loc(); + + /** + Constructs an rbd_loc with the given pool, image, and snap. + */ + rbd_loc(const std::string &pool, const std::string &image, const std::string &snap); + + /** + Parses an rbd_loc from the given string. + If parsing fails, the contents are unmodified. + @retval true if parsing succeeded + */ + bool parse(std::string name_string); + + /** + Returns the string representation of the locator. + */ + std::string str() const; + + /** + Compares the locators lexicographically by pool, then image, then snap. + */ + int compare(const rbd_loc& rhs) const; + + /** + Returns true if the locators have identical pool, image, and snap. + */ + bool operator==(const rbd_loc& rhs) const; + + /** + Compares the locators lexicographically by pool, then image, then snap. + */ + bool operator<(const rbd_loc& rhs) const; + + std::string pool; + + std::string image; + + std::string snap; +}; + +} + +#endif |