Debian Codegraph @

src/shared/loop-util.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include "shared-forward.h"
5
6 /* Some helpers for setting up loopback block devices */
7
8 typedef struct LoopDevice {
9 unsigned n_ref;
10 int fd;
11 int lock_fd;
12 int nr; /* The loopback device index (i.e. 4 for /dev/loop4); if this object encapsulates a non-loopback block device, set to -1 */
13 dev_t devno; /* The loopback device's own dev_t */
14 char *node;
15 sd_device *dev;
16 char *backing_file;
17 bool relinquished;
18 bool created; /* If we created the device */
19 dev_t backing_devno; /* The backing file's dev_t */
20 ino_t backing_inode; /* The backing file's ino_t */
21 uint64_t diskseq; /* Block device sequence number, monothonically incremented by the kernel on create/attach, or 0 if we don't know */
22 uint32_t sector_size;
23 uint64_t device_size;
24 } LoopDevice;
25
26 /* Returns true if LoopDevice object is not actually a loopback device but some other block device we just wrap */
27 #define LOOP_DEVICE_IS_FOREIGN(d) ((d)->nr < 0)
28
29 /* systemd-internal flags OR'd into the loop_flags argument of loop_device_make() and friends, in addition to
30 * the kernel's LO_FLAGS_*. These live in high bits to stay clear of the kernel values and are masked out
31 * before the flags reach the kernel.
32 *
33 * LOOP_DEVICE_MAY_POPULATE_PARTITION_TABLE: by default, when LO_FLAGS_PARTSCAN is requested but cannot be
34 * enabled on the device and the device carries no partition table, we hand back the original fd instead of
35 * allocating a loopback device — there's nothing to scan, and routing e.g. a multi-device btrfs member
36 * through a loopback breaks it (https://github.com/systemd/systemd/issues/42520). Callers that might write a
37 * (nested) partition table into the device and rely on partition scanning to pick it up afterwards must set
38 * this flag to force a real loopback device even when the device is currently unpartitioned. */
39 #define LOOP_DEVICE_MAY_POPULATE_PARTITION_TABLE (UINT32_C(1) << 16)
40
41 int loop_device_make(int fd, int open_flags, uint64_t offset, uint64_t size, uint32_t sector_size, uint32_t loop_flags, int lock_op, LoopDevice **ret);
42 int loop_device_make_by_path_at(int dir_fd, const char *path, int open_flags, uint32_t sector_size, uint32_t loop_flags, int lock_op, LoopDevice **ret);
43 static inline int loop_device_make_by_path(const char *path, int open_flags, uint32_t sector_size, uint32_t loop_flags, int lock_op, LoopDevice **ret) {
44 return loop_device_make_by_path_at(AT_FDCWD, path, open_flags, sector_size, loop_flags, lock_op, ret);
45 }
46 int loop_device_make_by_path_memory(const char *path, int open_flags, uint32_t sector_size, uint32_t loop_flags, int lock_op, LoopDevice **ret);
47 int loop_device_open(sd_device *dev, int open_flags, int lock_op, LoopDevice **ret);
48 int loop_device_open_from_fd(int fd, int open_flags, int lock_op, LoopDevice **ret);
49 int loop_device_open_from_path(const char *path, int open_flags, int lock_op, LoopDevice **ret);
50
51 DECLARE_TRIVIAL_REF_UNREF_FUNC(LoopDevice, loop_device);
52 DEFINE_TRIVIAL_CLEANUP_FUNC(LoopDevice*, loop_device_unref);
53
54 void loop_device_relinquish(LoopDevice *d);
55 void loop_device_unrelinquish(LoopDevice *d);
56
57 int loop_device_refresh_size(LoopDevice *d, uint64_t offset, uint64_t size);
58
59 int loop_device_flock(LoopDevice *d, int operation);
60 int loop_device_sync(LoopDevice *d);
61
62 int loop_device_set_autoclear(LoopDevice *d, bool autoclear);
63 int loop_device_set_filename(LoopDevice *d, const char *name);