]>
git.ipfire.org Git - thirdparty/util-linux.git/blob - include/loopdev.h
1 #ifndef UTIL_LINUX_LOOPDEV_H
2 #define UTIL_LINUX_LOOPDEV_H
7 * loop_info.lo_encrypt_type
9 #define LO_CRYPT_NONE 0
10 #define LO_CRYPT_XOR 1
11 #define LO_CRYPT_DES 2
12 #define LO_CRYPT_CRYPTOAPI 18
14 #define LOOP_SET_FD 0x4C00
15 #define LOOP_CLR_FD 0x4C01
17 * Obsolete (kernel < 2.6)
19 * #define LOOP_SET_STATUS 0x4C02
20 * #define LOOP_GET_STATUS 0x4C03
22 #define LOOP_SET_STATUS64 0x4C04
23 #define LOOP_GET_STATUS64 0x4C05
24 /* #define LOOP_CHANGE_FD 0x4C06 */
25 #define LOOP_SET_CAPACITY 0x4C07
26 #define LOOP_SET_DIRECT_IO 0x4C08
27 #define LOOP_SET_BLOCK_SIZE 0x4C09
29 /* /dev/loop-control interface */
31 # define LOOP_CTL_ADD 0x4C80
32 # define LOOP_CTL_REMOVE 0x4C81
33 # define LOOP_CTL_GET_FREE 0x4C82
40 LO_FLAGS_READ_ONLY
= 1,
41 LO_FLAGS_USE_AOPS
= 2,
42 LO_FLAGS_AUTOCLEAR
= 4, /* kernel >= 2.6.25 */
43 LO_FLAGS_PARTSCAN
= 8, /* kernel >= 3.2 */
44 LO_FLAGS_DIRECT_IO
= 16, /* kernel >= 4.2 */
47 #define LO_NAME_SIZE 64
48 #define LO_KEY_SIZE 32
51 * Linux LOOP_{SET,GET}_STATUS64 ioctl struct
58 uint64_t lo_sizelimit
; /* bytes, 0 == max available */
60 uint32_t lo_encrypt_type
;
61 uint32_t lo_encrypt_key_size
;
63 uint8_t lo_file_name
[LO_NAME_SIZE
];
64 uint8_t lo_crypt_name
[LO_NAME_SIZE
];
65 uint8_t lo_encrypt_key
[LO_KEY_SIZE
];
69 #define LOOPDEV_MAJOR 7 /* loop major number */
70 #define LOOPDEV_DEFAULT_NNODES 8 /* default number of loop devices */
73 FILE *proc
; /* /proc/partitions */
74 DIR *sysblock
; /* /sys/block */
75 int ncur
; /* current position */
76 int *minors
; /* ary of minor numbers (when scan whole /dev) */
77 int nminors
; /* number of items in *minors */
78 int ct_perm
; /* count permission problems */
79 int ct_succ
; /* count number of detected devices */
81 unsigned int done
:1; /* scanning done */
82 unsigned int default_check
:1;/* check first LOOPDEV_NLOOPS */
83 int flags
; /* LOOPITER_FL_* flags */
87 LOOPITER_FL_FREE
= (1 << 0),
88 LOOPITER_FL_USED
= (1 << 1)
92 * handler for work with loop devices
95 char device
[128]; /* device path (e.g. /dev/loop<N>) */
96 char *filename
; /* backing file for loopcxt_set_... */
97 int fd
; /* open(/dev/looo<N>) */
98 int mode
; /* fd mode O_{RDONLY,RDWR} */
99 uint64_t blocksize
; /* used by loopcxt_setup_device() */
101 int flags
; /* LOOPDEV_FL_* flags */
102 unsigned int has_info
:1; /* .info contains data */
103 unsigned int extra_check
:1; /* unusual stuff for iterator */
104 unsigned int info_failed
:1; /* LOOP_GET_STATUS ioctl failed */
105 unsigned int control_ok
:1; /* /dev/loop-control success */
107 struct path_cxt
*sysfs
; /* pointer to /sys/dev/block/<maj:min>/ */
108 struct loop_info64 info
; /* for GET/SET ioctl */
109 struct loopdev_iter iter
; /* scans /sys or /dev for used/free devices */
112 #define UL_LOOPDEVCXT_EMPTY { .fd = -1 }
118 LOOPDEV_FL_RDONLY
= (1 << 0), /* open(/dev/loop) mode; default */
119 LOOPDEV_FL_RDWR
= (1 << 1), /* necessary for loop setup only */
120 LOOPDEV_FL_OFFSET
= (1 << 4),
121 LOOPDEV_FL_NOSYSFS
= (1 << 5),
122 LOOPDEV_FL_NOIOCTL
= (1 << 6),
123 LOOPDEV_FL_DEVSUBDIR
= (1 << 7),
124 LOOPDEV_FL_CONTROL
= (1 << 8), /* system with /dev/loop-control */
125 LOOPDEV_FL_SIZELIMIT
= (1 << 9)
131 extern int loopmod_supports_partscan(void);
133 extern int is_loopdev(const char *device
);
134 extern int loopdev_is_autoclear(const char *device
);
136 extern char *loopdev_get_backing_file(const char *device
);
137 extern int loopdev_is_used(const char *device
, const char *filename
,
138 uint64_t offset
, uint64_t sizelimit
, int flags
);
139 extern char *loopdev_find_by_backing_file(const char *filename
,
140 uint64_t offset
, uint64_t sizelimit
, int flags
);
141 extern int loopcxt_find_unused(struct loopdev_cxt
*lc
);
142 extern int loopdev_delete(const char *device
);
143 extern int loopdev_count_by_backing_file(const char *filename
, char **loopdev
);
148 extern int loopcxt_init(struct loopdev_cxt
*lc
, int flags
)
149 __attribute__ ((warn_unused_result
));
150 extern void loopcxt_deinit(struct loopdev_cxt
*lc
);
152 extern int loopcxt_set_device(struct loopdev_cxt
*lc
, const char *device
)
153 __attribute__ ((warn_unused_result
));
154 extern int loopcxt_has_device(struct loopdev_cxt
*lc
);
155 extern int loopcxt_add_device(struct loopdev_cxt
*lc
);
156 extern char *loopcxt_strdup_device(struct loopdev_cxt
*lc
);
157 extern const char *loopcxt_get_device(struct loopdev_cxt
*lc
);
158 extern struct loop_info64
*loopcxt_get_info(struct loopdev_cxt
*lc
);
160 extern int loopcxt_get_fd(struct loopdev_cxt
*lc
);
161 extern int loopcxt_set_fd(struct loopdev_cxt
*lc
, int fd
, int mode
);
163 extern int loopcxt_init_iterator(struct loopdev_cxt
*lc
, int flags
);
164 extern int loopcxt_deinit_iterator(struct loopdev_cxt
*lc
);
165 extern int loopcxt_next(struct loopdev_cxt
*lc
);
167 extern int loopcxt_setup_device(struct loopdev_cxt
*lc
);
168 extern int loopcxt_delete_device(struct loopdev_cxt
*lc
);
170 extern int loopcxt_ioctl_status(struct loopdev_cxt
*lc
);
171 extern int loopcxt_ioctl_capacity(struct loopdev_cxt
*lc
);
172 extern int loopcxt_ioctl_dio(struct loopdev_cxt
*lc
, unsigned long use_dio
);
173 extern int loopcxt_ioctl_blocksize(struct loopdev_cxt
*lc
, uint64_t blocksize
);
175 int loopcxt_set_offset(struct loopdev_cxt
*lc
, uint64_t offset
);
176 int loopcxt_set_sizelimit(struct loopdev_cxt
*lc
, uint64_t sizelimit
);
177 int loopcxt_set_blocksize(struct loopdev_cxt
*lc
, uint64_t blocksize
);
178 int loopcxt_set_flags(struct loopdev_cxt
*lc
, uint32_t flags
);
179 int loopcxt_set_backing_file(struct loopdev_cxt
*lc
, const char *filename
);
181 extern char *loopcxt_get_backing_file(struct loopdev_cxt
*lc
);
182 extern int loopcxt_get_backing_devno(struct loopdev_cxt
*lc
, dev_t
*devno
);
183 extern int loopcxt_get_backing_inode(struct loopdev_cxt
*lc
, ino_t
*ino
);
184 extern int loopcxt_get_offset(struct loopdev_cxt
*lc
, uint64_t *offset
);
185 extern int loopcxt_get_blocksize(struct loopdev_cxt
*lc
, uint64_t *blocksize
);
186 extern int loopcxt_get_sizelimit(struct loopdev_cxt
*lc
, uint64_t *size
);
187 extern int loopcxt_get_encrypt_type(struct loopdev_cxt
*lc
, uint32_t *type
);
188 extern const char *loopcxt_get_crypt_name(struct loopdev_cxt
*lc
);
189 extern int loopcxt_is_autoclear(struct loopdev_cxt
*lc
);
190 extern int loopcxt_is_readonly(struct loopdev_cxt
*lc
);
191 extern int loopcxt_is_dio(struct loopdev_cxt
*lc
);
192 extern int loopcxt_is_partscan(struct loopdev_cxt
*lc
);
193 extern int loopcxt_find_by_backing_file(struct loopdev_cxt
*lc
,
194 const char *filename
,
195 uint64_t offset
, uint64_t sizelimit
,
197 extern int loopcxt_find_overlap(struct loopdev_cxt
*lc
,
198 const char *filename
,
199 uint64_t offset
, uint64_t sizelimit
);
201 extern int loopcxt_is_used(struct loopdev_cxt
*lc
,
203 const char *backing_file
,
208 #endif /* UTIL_LINUX_LOOPDEV_H */