Branch data Line data Source code
1 : : /* SPDX-License-Identifier: BSD-3-Clause
2 : : * Copyright (C) 2017 Intel Corporation.
3 : : * All rights reserved.
4 : : * Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
5 : : */
6 : :
7 : : #ifndef SPDK_BLOBSTORE_H
8 : : #define SPDK_BLOBSTORE_H
9 : :
10 : : #include "spdk/assert.h"
11 : : #include "spdk/blob.h"
12 : : #include "spdk/queue.h"
13 : : #include "spdk/util.h"
14 : : #include "spdk/tree.h"
15 : : #include "spdk/thread.h"
16 : :
17 : : #include "request.h"
18 : :
19 : : /* In Memory Data Structures
20 : : *
21 : : * The following data structures exist only in memory.
22 : : */
23 : :
24 : : #define SPDK_BLOB_OPTS_CLUSTER_SZ (1024 * 1024)
25 : : #define SPDK_BLOB_OPTS_NUM_MD_PAGES UINT32_MAX
26 : : #define SPDK_BLOB_OPTS_MAX_MD_OPS 32
27 : : #define SPDK_BLOB_OPTS_DEFAULT_CHANNEL_OPS 512
28 : : #define SPDK_BLOB_BLOBID_HIGH_BIT (1ULL << 32)
29 : :
30 : : struct spdk_xattr {
31 : : uint32_t index;
32 : : uint16_t value_len;
33 : : char *name;
34 : : void *value;
35 : : TAILQ_ENTRY(spdk_xattr) link;
36 : : };
37 : :
38 : : /* The mutable part of the blob data that is sync'd to
39 : : * disk. The data in here is both mutable and persistent.
40 : : */
41 : : struct spdk_blob_mut_data {
42 : : /* Number of data clusters in the blob */
43 : : uint64_t num_clusters;
44 : :
45 : : /* Array LBAs that are the beginning of a cluster, in
46 : : * the order they appear in the blob.
47 : : */
48 : : uint64_t *clusters;
49 : :
50 : : /* The size of the clusters array. This is greater than or
51 : : * equal to 'num_clusters'.
52 : : */
53 : : size_t cluster_array_size;
54 : :
55 : : /* The number of allocated clusters in the clusters array */
56 : : uint64_t num_allocated_clusters;
57 : :
58 : : /* Number of extent pages */
59 : : uint64_t num_extent_pages;
60 : :
61 : : /* Array of page offsets into the metadata region,
62 : : * containing extents. Can contain entries for not yet
63 : : * allocated pages. */
64 : : uint32_t *extent_pages;
65 : :
66 : : /* The size of the extent page array. This is greater than or
67 : : * equal to 'num_extent_pages'. */
68 : : size_t extent_pages_array_size;
69 : :
70 : : /* Number of metadata pages */
71 : : uint32_t num_pages;
72 : :
73 : : /* Array of page offsets into the metadata region, in
74 : : * the order of the metadata page sequence.
75 : : */
76 : : uint32_t *pages;
77 : : };
78 : :
79 : : enum spdk_blob_state {
80 : : /* The blob in-memory version does not match the on-disk
81 : : * version.
82 : : */
83 : : SPDK_BLOB_STATE_DIRTY,
84 : :
85 : : /* The blob in memory version of the blob matches the on disk
86 : : * version.
87 : : */
88 : : SPDK_BLOB_STATE_CLEAN,
89 : :
90 : : /* The in-memory state being synchronized with the on-disk
91 : : * blob state. */
92 : : SPDK_BLOB_STATE_LOADING,
93 : : };
94 : :
95 : : TAILQ_HEAD(spdk_xattr_tailq, spdk_xattr);
96 : :
97 : : struct spdk_blob_list {
98 : : spdk_blob_id id;
99 : : size_t clone_count;
100 : : TAILQ_HEAD(, spdk_blob_list) clones;
101 : : TAILQ_ENTRY(spdk_blob_list) link;
102 : : };
103 : :
104 : : struct spdk_blob {
105 : : struct spdk_blob_store *bs;
106 : :
107 : : uint32_t open_ref;
108 : :
109 : : spdk_blob_id id;
110 : : spdk_blob_id parent_id;
111 : :
112 : : enum spdk_blob_state state;
113 : :
114 : : /* Two copies of the mutable data. One is a version
115 : : * that matches the last known data on disk (clean).
116 : : * The other (active) is the current data. Syncing
117 : : * a blob makes the clean match the active.
118 : : */
119 : : struct spdk_blob_mut_data clean;
120 : : struct spdk_blob_mut_data active;
121 : :
122 : : bool invalid;
123 : : bool data_ro;
124 : : bool md_ro;
125 : :
126 : : uint64_t invalid_flags;
127 : : uint64_t data_ro_flags;
128 : : uint64_t md_ro_flags;
129 : :
130 : : struct spdk_bs_dev *back_bs_dev;
131 : :
132 : : /* TODO: The xattrs are mutable, but we don't want to be
133 : : * copying them unnecessarily. Figure this out.
134 : : */
135 : : struct spdk_xattr_tailq xattrs;
136 : : struct spdk_xattr_tailq xattrs_internal;
137 : :
138 : : RB_ENTRY(spdk_blob) link;
139 : :
140 : : uint32_t frozen_refcnt;
141 : : bool locked_operation_in_progress;
142 : : enum blob_clear_method clear_method;
143 : : bool extent_rle_found;
144 : : bool extent_table_found;
145 : : bool use_extent_table;
146 : :
147 : : /* A list of pending metadata pending_persists */
148 : : TAILQ_HEAD(, spdk_blob_persist_ctx) pending_persists;
149 : : TAILQ_HEAD(, spdk_blob_persist_ctx) persists_to_complete;
150 : :
151 : : /* Number of data clusters retrieved from extent table,
152 : : * that many have to be read from extent pages. */
153 : : uint64_t remaining_clusters_in_et;
154 : : };
155 : :
156 : : struct spdk_blob_store {
157 : : uint64_t md_start; /* Offset from beginning of disk, in pages */
158 : : uint32_t md_len; /* Count, in pages */
159 : : uint32_t md_page_size; /* Metadata page size */
160 : :
161 : : struct spdk_io_channel *md_channel;
162 : : uint32_t max_channel_ops;
163 : :
164 : : struct spdk_thread *md_thread;
165 : :
166 : : struct spdk_bs_dev *dev;
167 : :
168 : : struct spdk_bit_array *used_md_pages; /* Protected by used_lock */
169 : : struct spdk_bit_pool *used_clusters; /* Protected by used_lock */
170 : : struct spdk_bit_array *used_blobids;
171 : : struct spdk_bit_array *open_blobids;
172 : :
173 : : struct spdk_spinlock used_lock;
174 : :
175 : : uint32_t cluster_sz;
176 : : uint64_t total_clusters;
177 : : uint64_t total_data_clusters;
178 : : uint64_t num_free_clusters; /* Protected by used_lock */
179 : : uint64_t pages_per_cluster;
180 : : uint64_t io_units_per_cluster;
181 : : uint8_t pages_per_cluster_shift;
182 : : uint8_t io_units_per_cluster_shift;
183 : : uint32_t io_unit_size;
184 : :
185 : : spdk_blob_id super_blob;
186 : : struct spdk_bs_type bstype;
187 : :
188 : : struct spdk_bs_cpl unload_cpl;
189 : : int unload_err;
190 : :
191 : : RB_HEAD(spdk_blob_tree, spdk_blob) open_blobs;
192 : : TAILQ_HEAD(, spdk_blob_list) snapshots;
193 : :
194 : : bool clean;
195 : :
196 : : spdk_bs_esnap_dev_create esnap_bs_dev_create;
197 : : void *esnap_ctx;
198 : :
199 : : /* If external snapshot channels are being destroyed while
200 : : * the blobstore is unloaded, the unload is deferred until
201 : : * after the channel destruction completes.
202 : : */
203 : : uint32_t esnap_channels_unloading;
204 : : spdk_bs_op_complete esnap_unload_cb_fn;
205 : : void *esnap_unload_cb_arg;
206 : : };
207 : :
208 : : struct spdk_bs_channel {
209 : : struct spdk_bs_request_set *req_mem;
210 : : TAILQ_HEAD(, spdk_bs_request_set) reqs;
211 : :
212 : : struct spdk_blob_store *bs;
213 : :
214 : : struct spdk_bs_dev *dev;
215 : : struct spdk_io_channel *dev_channel;
216 : :
217 : : /* This page is only used during insert of a new cluster. */
218 : : struct spdk_blob_md_page *new_cluster_page;
219 : :
220 : : TAILQ_HEAD(, spdk_bs_request_set) need_cluster_alloc;
221 : : TAILQ_HEAD(, spdk_bs_request_set) queued_io;
222 : :
223 : : RB_HEAD(blob_esnap_channel_tree, blob_esnap_channel) esnap_channels;
224 : : };
225 : :
226 : : /** operation type */
227 : : enum spdk_blob_op_type {
228 : : SPDK_BLOB_WRITE,
229 : : SPDK_BLOB_READ,
230 : : SPDK_BLOB_UNMAP,
231 : : SPDK_BLOB_WRITE_ZEROES,
232 : : SPDK_BLOB_WRITEV,
233 : : SPDK_BLOB_READV,
234 : : };
235 : :
236 : : /* back bs_dev */
237 : :
238 : : #define BLOB_SNAPSHOT "SNAP"
239 : : #define SNAPSHOT_IN_PROGRESS "SNAPTMP"
240 : : #define SNAPSHOT_PENDING_REMOVAL "SNAPRM"
241 : : #define BLOB_EXTERNAL_SNAPSHOT_ID "EXTSNAP"
242 : :
243 : : struct spdk_blob_bs_dev {
244 : : struct spdk_bs_dev bs_dev;
245 : : struct spdk_blob *blob;
246 : : };
247 : :
248 : : /* On-Disk Data Structures
249 : : *
250 : : * The following data structures exist on disk.
251 : : */
252 : : #define SPDK_BS_INITIAL_VERSION 1
253 : : #define SPDK_BS_VERSION 3 /* current version */
254 : :
255 : : #pragma pack(push, 1)
256 : :
257 : : #define SPDK_MD_MASK_TYPE_USED_PAGES 0
258 : : #define SPDK_MD_MASK_TYPE_USED_CLUSTERS 1
259 : : #define SPDK_MD_MASK_TYPE_USED_BLOBIDS 2
260 : :
261 : : struct spdk_bs_md_mask {
262 : : uint8_t type;
263 : : uint32_t length; /* In bits */
264 : : uint8_t mask[0];
265 : : };
266 : :
267 : : #define SPDK_MD_DESCRIPTOR_TYPE_PADDING 0
268 : : #define SPDK_MD_DESCRIPTOR_TYPE_XATTR 2
269 : : #define SPDK_MD_DESCRIPTOR_TYPE_FLAGS 3
270 : : #define SPDK_MD_DESCRIPTOR_TYPE_XATTR_INTERNAL 4
271 : :
272 : : /* Following descriptors define cluster layout in a blob.
273 : : * EXTENT_RLE cannot be present in blobs metadata,
274 : : * at the same time as EXTENT_TABLE and EXTENT_PAGE descriptors. */
275 : :
276 : : /* EXTENT_RLE descriptor holds an array of LBA that points to
277 : : * beginning of allocated clusters. The array is run-length encoded,
278 : : * with 0's being unallocated clusters. It is part of serialized
279 : : * metadata chain for a blob. */
280 : : #define SPDK_MD_DESCRIPTOR_TYPE_EXTENT_RLE 1
281 : : /* EXTENT_TABLE descriptor holds array of md page offsets that
282 : : * point to pages with EXTENT_PAGE descriptor. The 0's in the array
283 : : * are run-length encoded, non-zero values are unallocated pages.
284 : : * It is part of serialized metadata chain for a blob. */
285 : : #define SPDK_MD_DESCRIPTOR_TYPE_EXTENT_TABLE 5
286 : : /* EXTENT_PAGE descriptor holds an array of LBAs that point to
287 : : * beginning of allocated clusters. The array is run-length encoded,
288 : : * with 0's being unallocated clusters. It is NOT part of
289 : : * serialized metadata chain for a blob. */
290 : : #define SPDK_MD_DESCRIPTOR_TYPE_EXTENT_PAGE 6
291 : :
292 : : struct spdk_blob_md_descriptor_xattr {
293 : : uint8_t type;
294 : : uint32_t length;
295 : :
296 : : uint16_t name_length;
297 : : uint16_t value_length;
298 : :
299 : : char name[0];
300 : : /* String name immediately followed by string value. */
301 : : };
302 : :
303 : : struct spdk_blob_md_descriptor_extent_rle {
304 : : uint8_t type;
305 : : uint32_t length;
306 : :
307 : : struct {
308 : : uint32_t cluster_idx;
309 : : uint32_t length; /* In units of clusters */
310 : : } extents[0];
311 : : };
312 : :
313 : : struct spdk_blob_md_descriptor_extent_table {
314 : : uint8_t type;
315 : : uint32_t length;
316 : :
317 : : /* Number of data clusters in the blob */
318 : : uint64_t num_clusters;
319 : :
320 : : struct {
321 : : uint32_t page_idx;
322 : : uint32_t num_pages; /* In units of pages */
323 : : } extent_page[0];
324 : : };
325 : :
326 : : struct spdk_blob_md_descriptor_extent_page {
327 : : uint8_t type;
328 : : uint32_t length;
329 : :
330 : : /* First cluster index in this extent page */
331 : : uint32_t start_cluster_idx;
332 : :
333 : : uint32_t cluster_idx[0];
334 : : };
335 : :
336 : : #define SPDK_BLOB_THIN_PROV (1ULL << 0)
337 : : #define SPDK_BLOB_INTERNAL_XATTR (1ULL << 1)
338 : : #define SPDK_BLOB_EXTENT_TABLE (1ULL << 2)
339 : : #define SPDK_BLOB_EXTERNAL_SNAPSHOT (1ULL << 3)
340 : : #define SPDK_BLOB_INVALID_FLAGS_MASK (SPDK_BLOB_THIN_PROV | SPDK_BLOB_INTERNAL_XATTR | \
341 : : SPDK_BLOB_EXTENT_TABLE | SPDK_BLOB_EXTERNAL_SNAPSHOT)
342 : :
343 : : #define SPDK_BLOB_READ_ONLY (1ULL << 0)
344 : : #define SPDK_BLOB_DATA_RO_FLAGS_MASK SPDK_BLOB_READ_ONLY
345 : :
346 : : #define SPDK_BLOB_CLEAR_METHOD_SHIFT 0
347 : : #define SPDK_BLOB_CLEAR_METHOD (3ULL << SPDK_BLOB_CLEAR_METHOD_SHIFT)
348 : : #define SPDK_BLOB_MD_RO_FLAGS_MASK SPDK_BLOB_CLEAR_METHOD
349 : :
350 : : struct spdk_blob_md_descriptor_flags {
351 : : uint8_t type;
352 : : uint32_t length;
353 : :
354 : : /*
355 : : * If a flag in invalid_flags is set that the application is not aware of,
356 : : * it will not allow the blob to be opened.
357 : : */
358 : : uint64_t invalid_flags;
359 : :
360 : : /*
361 : : * If a flag in data_ro_flags is set that the application is not aware of,
362 : : * allow the blob to be opened in data_read_only and md_read_only mode.
363 : : */
364 : : uint64_t data_ro_flags;
365 : :
366 : : /*
367 : : * If a flag in md_ro_flags is set the application is not aware of,
368 : : * allow the blob to be opened in md_read_only mode.
369 : : */
370 : : uint64_t md_ro_flags;
371 : : };
372 : :
373 : : struct spdk_blob_md_descriptor {
374 : : uint8_t type;
375 : : uint32_t length;
376 : : };
377 : :
378 : : #define SPDK_INVALID_MD_PAGE UINT32_MAX
379 : :
380 : : struct spdk_blob_md_page {
381 : : spdk_blob_id id;
382 : :
383 : : uint32_t sequence_num;
384 : : uint32_t reserved0;
385 : :
386 : : /* Descriptors here */
387 : : uint8_t descriptors[4072];
388 : :
389 : : uint32_t next;
390 : : uint32_t crc;
391 : : };
392 : : #define SPDK_BS_PAGE_SIZE 0x1000
393 : : SPDK_STATIC_ASSERT(SPDK_BS_PAGE_SIZE == sizeof(struct spdk_blob_md_page), "Invalid md page size");
394 : :
395 : : #define SPDK_BS_MAX_DESC_SIZE SPDK_SIZEOF_MEMBER(struct spdk_blob_md_page, descriptors)
396 : :
397 : : /* Maximum number of extents a single Extent Page can fit.
398 : : * For an SPDK_BS_PAGE_SIZE of 4K SPDK_EXTENTS_PER_EP would be 512. */
399 : : #define SPDK_EXTENTS_PER_EP_MAX ((SPDK_BS_MAX_DESC_SIZE - sizeof(struct spdk_blob_md_descriptor_extent_page)) / sizeof(uint32_t))
400 : : #define SPDK_EXTENTS_PER_EP (spdk_align64pow2(SPDK_EXTENTS_PER_EP_MAX + 1) >> 1u)
401 : :
402 : : #define SPDK_BS_SUPER_BLOCK_SIG "SPDKBLOB"
403 : :
404 : : struct spdk_bs_super_block {
405 : : uint8_t signature[8];
406 : : uint32_t version;
407 : : uint32_t length;
408 : : uint32_t clean; /* If there was a clean shutdown, this is 1. */
409 : : spdk_blob_id super_blob;
410 : :
411 : : uint32_t cluster_size; /* In bytes */
412 : :
413 : : uint32_t used_page_mask_start; /* Offset from beginning of disk, in pages */
414 : : uint32_t used_page_mask_len; /* Count, in pages */
415 : :
416 : : uint32_t used_cluster_mask_start; /* Offset from beginning of disk, in pages */
417 : : uint32_t used_cluster_mask_len; /* Count, in pages */
418 : :
419 : : uint32_t md_start; /* Offset from beginning of disk, in pages */
420 : : uint32_t md_len; /* Count, in pages */
421 : :
422 : : struct spdk_bs_type bstype; /* blobstore type */
423 : :
424 : : uint32_t used_blobid_mask_start; /* Offset from beginning of disk, in pages */
425 : : uint32_t used_blobid_mask_len; /* Count, in pages */
426 : :
427 : : uint64_t size; /* size of blobstore in bytes */
428 : : uint32_t io_unit_size; /* Size of io unit in bytes */
429 : :
430 : : uint32_t md_page_size; /* Size in bytes */
431 : : uint8_t reserved[3996];
432 : :
433 : : uint32_t crc;
434 : : };
435 : : SPDK_STATIC_ASSERT(sizeof(struct spdk_bs_super_block) == 0x1000, "Invalid super block size");
436 : :
437 : : #pragma pack(pop)
438 : :
439 : : struct spdk_bs_dev *bs_create_zeroes_dev(void);
440 : : struct spdk_bs_dev *bs_create_blob_bs_dev(struct spdk_blob *blob);
441 : : struct spdk_io_channel *blob_esnap_get_io_channel(struct spdk_io_channel *ch,
442 : : struct spdk_blob *blob);
443 : : bool blob_backed_with_zeroes_dev(struct spdk_blob *blob);
444 : :
445 : : /* Unit Conversions
446 : : *
447 : : * The blobstore works with several different units:
448 : : * - Byte: Self explanatory
449 : : * - LBA: The logical blocks on the backing storage device.
450 : : * - Page: The read/write units of blobs and metadata. This is
451 : : * an offset into a blob in units of 4KiB.
452 : : * - Cluster Index: The disk is broken into a sequential list of
453 : : * clusters. This is the offset from the beginning.
454 : : *
455 : : * NOTE: These conversions all act on simple magnitudes, not with any sort
456 : : * of knowledge about the blobs themselves. For instance, converting
457 : : * a page to an lba with the conversion function below simply converts
458 : : * a number of pages to an equivalent number of lbas, but that
459 : : * lba certainly isn't the right lba that corresponds to a page offset
460 : : * for a particular blob.
461 : : */
462 : : static inline uint64_t
463 : 381718 : bs_byte_to_lba(struct spdk_blob_store *bs, uint64_t length)
464 : : {
465 [ + + + + : 381718 : assert(length % bs->dev->blocklen == 0);
+ - + - +
- + - #
# ]
466 : :
467 [ + + + - : 381718 : return length / bs->dev->blocklen;
+ - + - +
- ]
468 : : }
469 : :
470 : : static inline uint64_t
471 : 17126 : bs_dev_byte_to_lba(struct spdk_bs_dev *bs_dev, uint64_t length)
472 : : {
473 [ + + - + : 17126 : assert(length % bs_dev->blocklen == 0);
# # # # #
# ]
474 : :
475 [ - + # # : 17126 : return length / bs_dev->blocklen;
# # ]
476 : : }
477 : :
478 : : static inline uint64_t
479 : 234494 : bs_page_to_lba(struct spdk_blob_store *bs, uint64_t page)
480 : : {
481 [ + + + - : 234494 : return page * bs->md_page_size / bs->dev->blocklen;
+ - + - +
- + - +
- ]
482 : : }
483 : :
484 : : static inline uint64_t
485 : 183920 : bs_md_page_to_lba(struct spdk_blob_store *bs, uint32_t page)
486 : : {
487 [ + + # # : 183920 : assert(page < bs->md_len);
# # # # ]
488 [ # # # # ]: 183920 : return bs_page_to_lba(bs, page + bs->md_start);
489 : : }
490 : :
491 : : static inline uint64_t
492 : 19257 : bs_dev_io_unit_to_lba(struct spdk_blob *blob, struct spdk_bs_dev *bs_dev, uint64_t io_unit)
493 : : {
494 [ - + # # : 19257 : return io_unit * blob->bs->io_unit_size / bs_dev->blocklen;
# # # # #
# # # #
# ]
495 : : }
496 : :
497 : : static inline uint64_t
498 : 173 : bs_cluster_to_io_unit(struct spdk_blob_store *bs, uint32_t cluster)
499 : : {
500 [ # # # # ]: 173 : return (uint64_t)cluster * bs->io_units_per_cluster;
501 : : }
502 : :
503 : : static inline uint32_t
504 : 2195 : bs_io_unit_to_cluster(struct spdk_blob_store *bs, uint64_t io_unit)
505 : : {
506 [ + + - + : 2195 : assert(io_unit % bs->io_units_per_cluster == 0);
# # # # #
# ]
507 : :
508 [ - + # # : 2195 : return io_unit / bs->io_units_per_cluster;
# # ]
509 : : }
510 : :
511 : : static inline uint64_t
512 : 16472644 : bs_cluster_to_lba(struct spdk_blob_store *bs, uint32_t cluster)
513 : : {
514 [ + + - + : 16472644 : assert(bs->cluster_sz / bs->dev->blocklen > 0);
# # # # #
# # # # #
# # # # ]
515 : :
516 [ - + # # : 16472644 : return (uint64_t)cluster * (bs->cluster_sz / bs->dev->blocklen);
# # # # #
# # # #
# ]
517 : : }
518 : :
519 : : static inline uint32_t
520 : 6436795 : bs_lba_to_cluster(struct spdk_blob_store *bs, uint64_t lba)
521 : : {
522 [ + + - + : 6436795 : assert(lba % (bs->cluster_sz / bs->dev->blocklen) == 0);
- + # # #
# # # # #
# # # # #
# ]
523 : :
524 [ - + - + : 6436795 : return lba / (bs->cluster_sz / bs->dev->blocklen);
# # # # #
# # # # #
# # ]
525 : : }
526 : :
527 : : static inline uint64_t
528 : 1637894 : bs_io_unit_to_back_dev_lba(struct spdk_blob *blob, uint64_t io_unit)
529 : : {
530 [ - + # # : 1637894 : return io_unit * (blob->bs->io_unit_size / blob->back_bs_dev->blocklen);
# # # # #
# # # # #
# # # # ]
531 : : }
532 : :
533 : : static inline uint64_t
534 : 583394 : bs_cluster_to_extent_table_id(uint64_t cluster_num)
535 : : {
536 [ - + # # ]: 583394 : return cluster_num / SPDK_EXTENTS_PER_EP;
537 : : }
538 : :
539 : : static inline uint32_t *
540 : 583394 : bs_cluster_to_extent_page(struct spdk_blob *blob, uint64_t cluster_num)
541 : : {
542 : 583394 : uint64_t extent_table_id = bs_cluster_to_extent_table_id(cluster_num);
543 : :
544 [ + + - + : 583394 : assert(blob->use_extent_table);
# # # # #
# ]
545 [ + + # # : 583394 : assert(extent_table_id < blob->active.extent_pages_array_size);
# # # # #
# ]
546 : :
547 [ # # # # : 583394 : return &blob->active.extent_pages[extent_table_id];
# # # # ]
548 : : }
549 : :
550 : : static inline uint64_t
551 : 8036820 : bs_io_units_per_cluster(struct spdk_blob *blob)
552 : : {
553 [ # # # # : 8036820 : return blob->bs->io_units_per_cluster;
# # # # ]
554 : : }
555 : :
556 : : /* End basic conversions */
557 : :
558 : : static inline uint64_t
559 : 268270 : bs_blobid_to_page(spdk_blob_id id)
560 : : {
561 : 268270 : return id & 0xFFFFFFFF;
562 : : }
563 : :
564 : : /* The blob id is a 64 bit number. The lower 32 bits are the page_idx. The upper
565 : : * 32 bits are not currently used. Stick a 1 there just to catch bugs where the
566 : : * code assumes blob id == page_idx.
567 : : */
568 : : static inline spdk_blob_id
569 : 15739 : bs_page_to_blobid(uint64_t page_idx)
570 : : {
571 [ - + ]: 15739 : if (page_idx > UINT32_MAX) {
572 : 0 : return SPDK_BLOBID_INVALID;
573 : : }
574 [ # # ]: 15739 : return SPDK_BLOB_BLOBID_HIGH_BIT | page_idx;
575 : 3170 : }
576 : :
577 : : /* Given an io unit offset into a blob, look up the LBA for the
578 : : * start of that io unit.
579 : : */
580 : : static inline uint64_t
581 : 15205315 : bs_blob_io_unit_to_lba(struct spdk_blob *blob, uint64_t io_unit)
582 : : {
583 : : uint64_t lba;
584 : : uint8_t shift;
585 [ # # # # : 15205315 : uint64_t io_units_per_cluster = blob->bs->io_units_per_cluster;
# # # # ]
586 : :
587 [ # # # # : 15205315 : shift = blob->bs->io_units_per_cluster_shift;
# # # # ]
588 [ + + # # : 15205315 : assert(io_unit < blob->active.num_clusters * io_units_per_cluster);
# # # # #
# ]
589 [ + - ]: 15205315 : if (shift != 0) {
590 [ - + # # : 15205315 : lba = blob->active.clusters[io_unit >> shift];
# # # # #
# # # ]
591 : 109406 : } else {
592 [ # # # # : 0 : lba = blob->active.clusters[io_unit / io_units_per_cluster];
# # # # #
# # # ]
593 : : }
594 [ + + ]: 15205315 : if (lba == 0) {
595 : 819551 : return 0;
596 : : } else {
597 [ - + ]: 14385764 : return lba + io_unit % io_units_per_cluster;
598 : : }
599 : 109406 : }
600 : :
601 : : /* Given an io_unit offset into a blob, look up the number of io_units until the
602 : : * next cluster boundary.
603 : : */
604 : : static inline uint32_t
605 : 8036120 : bs_num_io_units_to_cluster_boundary(struct spdk_blob *blob, uint64_t io_unit)
606 : : {
607 : : uint64_t io_units_per_cluster;
608 : :
609 : 8036120 : io_units_per_cluster = bs_io_units_per_cluster(blob);
610 : :
611 [ - + ]: 8036120 : return io_units_per_cluster - (io_unit % io_units_per_cluster);
612 : : }
613 : :
614 : : /* Given an io_unit offset into a blob, look up the number of io_unit into blob to beginning of current cluster */
615 : : static inline uint64_t
616 : 6232 : bs_io_unit_to_cluster_start(struct spdk_blob *blob, uint64_t io_unit)
617 : : {
618 [ # # # # : 6232 : uint64_t io_units_per_cluster = blob->bs->io_units_per_cluster;
# # # # ]
619 : :
620 [ - + ]: 6232 : return io_unit - (io_unit % io_units_per_cluster);
621 : : }
622 : :
623 : : /* Given an io_unit offset into a blob, look up the number of pages into blob to beginning of current cluster */
624 : : static inline uint32_t
625 : 6232 : bs_io_unit_to_cluster_number(struct spdk_blob *blob, uint64_t io_unit)
626 : : {
627 [ # # # # : 6232 : uint64_t io_units_per_cluster = blob->bs->io_units_per_cluster;
# # # # ]
628 [ # # # # : 6232 : uint8_t shift = blob->bs->io_units_per_cluster_shift;
# # # # ]
629 : :
630 [ + - ]: 6232 : if (shift != 0) {
631 [ - + ]: 6232 : return io_unit >> shift;
632 : : } else {
633 [ # # ]: 0 : return io_unit / io_units_per_cluster;
634 : : }
635 : 1100 : }
636 : :
637 : : /* Given an io unit offset into a blob, look up if it is from allocated cluster. */
638 : : static inline bool
639 : 8013223 : bs_io_unit_is_allocated(struct spdk_blob *blob, uint64_t io_unit)
640 : : {
641 : 8013223 : uint64_t lba = bs_blob_io_unit_to_lba(blob, io_unit);
642 : :
643 [ + + ]: 8013223 : if (lba == 0) {
644 [ - + # # ]: 819551 : assert(spdk_blob_is_thin_provisioned(blob));
645 : 819551 : return false;
646 : : } else {
647 : 7193672 : return true;
648 : : }
649 : 57699 : }
650 : :
651 : : #endif
|