dae56d0c65
rbd: update doc comments for rbd image Read and Write funcs
...
The comments above Read and Write were very old and not up to our
current standards. Update them to be accurate and note that the
offset internal to the image type is not concurrency safe.
This also cleans up some old and unhelpful todos.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-02-09 15:59:48 +00:00
bae93ac4ab
rbd: export image name
...
Signed-off-by: Seena Fallah <seenafallah@gmail.com>
2021-11-09 02:31:09 +00:00
26fd846da1
docs: update comments of preview and deprecated APIs
...
Signed-off-by: Sven Anderson <sven@redhat.com>
2021-10-04 18:58:35 +00:00
7f74708d5b
rbd: clearly mark open function as deprecated
...
Use the notation described in the new API stability doc.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-09-30 13:27:01 +00:00
4f9322e9f1
rbd: add revive directives to ignore underscores in ImageInfo
...
These are public fields of a public type and changing them would be
a breaking change. Add revive comment directives to ignore them
so we can continue to have names in this struct that violate the
Go naming convention.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
8ea2109309
rbd: naming conventions: fixes in RemoveImage function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
ae97cd3e7d
rbd: naming conventions: fixes in CreateImage function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
6abfb039a4
rbd: naming conventions: fixes in TrashRemove, TrashRestore functions
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
e4cfae9eaa
rbd: naming conventions: fixes in SetSnapshot function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
1cbbe2cea5
rbd: naming conventions: fixes in GetSnapshotNames function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
d1b251fef5
rbd: naming conventions: fixes in BreakLock function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
8848df53e1
rbd: naming conventions: fixes in Unlock function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
70db71e0b6
rbd: naming conventions: fixes in LockExclusive, LockShared functions
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
05538bceab
rbd: naming conventions: fixes in ListLockers function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
96846c2ccf
rbd: naming conventions: fixes in Copy function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
2add913aaf
rbd: naming conventions: fixes in GetStripeCount, GetStripeUnit functions
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
ee7767a0d3
rbd: naming conventions: fixes in IsOldFormat function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
f4769e6f89
rbd: naming conventions: fixes in Stat function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
751c644eb5
rbd: naming conventions: fixes in Rename function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
07df8d3338
rbd: naming conventions: fixes in Trash function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
645fd2be49
rbd: naming conventions: fixes in Clone function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
3d2c476cd4
rbd: naming conventions: fixes in Create, Create2, Create3 functions
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
3a168ec717
rbd: naming conventions: fixes in Version function
...
Fix up variable names that don't meet Go standards.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-08-12 11:05:09 -04:00
92b808cbbe
rbd: add DeepCopy()
...
With rbd_deep_copy() an image can be copied with selected options. This
can be used to create a copy and flatten the image in one go.
Updates: ceph/ceph-csi#2077
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2021-06-01 14:40:37 +00:00
8e4b8349aa
rbd: add SetSnapshot (re)implementing rbd_snap_set
...
Signed-off-by: oct28.yjkim <oct28.yjkim@gmail.com>
2021-06-01 10:28:25 +00:00
c74cbb1dfe
rbd: fix argument type of rbd_writesame call
...
Signed-off-by: Sven Anderson <sven@redhat.com>
2021-05-19 13:38:06 +00:00
1748ad781c
rbd: test that cephIoctx helper panics when fed invalid inputs
...
As per go-ceph issue #427 , and a discussion in #399 this change and
test ensure that the cephIoctx helper function, that extracts the
C.rados_ioctx_t from a Go rados.IOContext, never returns a nil/null
C type.
As these are always "programming errors" panicking is reasonable
behavior for this case.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2021-02-01 15:31:17 +00:00
0afcf98b34
Add rbd_writesame()
...
In order to provide the ability to do thick provisioning of RBD images,
Image.WriteSame() can be used. The `rbd` commandline utility calls the
rbd_writesame() function when an image is created with the
`--thick-provision` option.
See-also: ceph/ceph-csi#1675
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2020-11-12 12:50:03 +00:00
eb84f5aba1
rbd: move image metadata functions to new go file
...
As rbd.go is very long, and the get-/set-/remove- metadata functions in
rbd.go make a nice logical unit, move them to a new metadata.go file.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-11-04 14:01:51 +00:00
7a387654c5
rbd: remove deprecated fields from ImageInfo struct
...
Corresponding fields for Parent_pool and Parent_name have been deprecated from
ceph's rbd_image_info_t stuct, removing the same from go-ceph's ImageInfo struct.
Signed-off-by: Mudit Agarwal <muagarwa@redhat.com>
2020-08-04 12:48:01 -04:00
3d5741301d
rbd: convert uses of split function to use cutil.SplitSparseBuffer
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-07-23 16:38:39 -04:00
6c944e8b65
rbd: make RBDError type unexported
...
In order to avoid external dependencies on implementation details,
this change replaces RBDError with the unexported rbdError. In case
some application really needs access to the integer value, it can use
the pattern
var errno interface{ Errno() int }
if errors.As(err, errno) { ... errno.Errno() ... }
Signed-off-by: Sven Anderson <sven@redhat.com>
2020-07-17 13:47:32 -04:00
5b45db6803
rbd: add Image.GetCreateTimestamp()
...
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2020-06-22 09:22:18 -04:00
ec822aa3a9
rbd: add error checking in CreateImage()
...
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2020-06-11 10:42:57 -04:00
3fc893bc0f
rbd: add error checking in RemoveImage()
...
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2020-06-11 10:42:57 -04:00
9e7a1c444f
rbd: add error checking in OpenImage*() functions
...
Signed-off-by: Niels de Vos <ndevos@redhat.com>
2020-06-11 10:42:57 -04:00
217e502afa
rbd: add better error when attempting to remove opened images
...
Signed-off-by: Sven Anderson <sven@redhat.com>
2020-05-28 08:49:35 -04:00
e8da761769
update various parts of the code to use the retry lib.
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
Signed-off-by: Sven Anderson <sven@redhat.com>
2020-04-20 15:08:36 -04:00
054ae8ddff
rbd: consolidate error types & values in an errors.go file
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-04-06 17:10:09 -04:00
eee19d642f
rbd: rename uses of RbdImageOptions to ImageOptions
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-23 10:09:25 -04:00
8f2671fee9
rbd: add doc comments for (Get|Set|Remove)Metadata funcs
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-23 10:09:25 -04:00
53fd07425a
rbd: add doc comment for GetSnapshotNames function
...
This function also happens to be mis-named.
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
644b7939d0
rbd: add doc comments for Flush function
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
51e9a080bb
rbd: add doc comments for ReadAt and WriteAt
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
223f1e01d7
rbd: add doc comment to Discard function
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
d71fb3b2ea
rbd: add a doc comment for the Seek function
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
c3e1a2d032
rbd: add doc comment for image type
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
eb1cccea2f
rbd: add doc comment for Locker type
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
b98ecb12fc
rbd: add doc comments for ImageInfo and SnapInfo types
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-20 09:43:15 -04:00
96396d4fca
rbd: temporarily disable revive caring about RBDError stuttering
...
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2020-03-17 09:56:49 -04:00
John Mulligan
Seena Fallah
Sven Anderson
Niels de Vos
oct28-yjkim
Mudit Agarwal