2 * volume_id - reads volume label and uuid
4 * Copyright (C) 2005-2007 Kay Sievers <kay.sievers@vrfy.org>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation version 2 of the License.
28 #include "libvolume_id.h"
31 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
34 volume_id_probe_fn_t prober;
38 static const struct prober prober_raid[] = {
39 { volume_id_probe_linux_raid, { "linux_raid", } },
40 { volume_id_probe_ddf_raid, { "ddf_raid", } },
41 { volume_id_probe_intel_software_raid, { "isw_raid", } },
42 { volume_id_probe_lsi_mega_raid, { "lsi_mega_raid", } },
43 { volume_id_probe_via_raid, { "via_raid", } },
44 { volume_id_probe_silicon_medley_raid, { "silicon_medley_raid", } },
45 { volume_id_probe_nvidia_raid, { "nvidia_raid", } },
46 { volume_id_probe_promise_fasttrack_raid, { "promise_fasttrack_raid", } },
47 { volume_id_probe_highpoint_45x_raid, { "highpoint_raid", } },
48 { volume_id_probe_adaptec_raid, { "adaptec_raid", } },
49 { volume_id_probe_jmicron_raid, { "jmicron_raid", } },
50 { volume_id_probe_lvm1, { "lvm1", } },
51 { volume_id_probe_lvm2, { "lvm2", } },
52 { volume_id_probe_highpoint_37x_raid, { "highpoint_raid", } },
55 static const struct prober prober_filesystem[] = {
56 { volume_id_probe_vfat, { "vfat", } },
57 { volume_id_probe_linux_swap, { "swap", } },
58 { volume_id_probe_luks, { "luks", } },
59 { volume_id_probe_xfs, { "xfs", } },
60 { volume_id_probe_ext, { "ext2", "ext3", "jbd", } },
61 { volume_id_probe_reiserfs, { "reiserfs", "reiser4", } },
62 { volume_id_probe_jfs, { "jfs", } },
63 { volume_id_probe_udf, { "udf", } },
64 { volume_id_probe_iso9660, { "iso9660", } },
65 { volume_id_probe_hfs_hfsplus, { "hfs", "hfsplus", } },
66 { volume_id_probe_ufs, { "ufs", } },
67 { volume_id_probe_ntfs, { "ntfs", } },
68 { volume_id_probe_cramfs, { "cramfs", } },
69 { volume_id_probe_romfs, { "romfs", } },
70 { volume_id_probe_hpfs, { "hpfs", } },
71 { volume_id_probe_sysv, { "sysv", "xenix", } },
72 { volume_id_probe_minix, { "minix", } },
73 { volume_id_probe_ocfs1, { "ocfs1", } },
74 { volume_id_probe_ocfs2, { "ocfs2", } },
75 { volume_id_probe_vxfs, { "vxfs", } },
76 { volume_id_probe_squashfs, { "squashfs", } },
77 { volume_id_probe_netware, { "netware", } },
80 /* the user can overwrite this log function */
81 static void default_log(int priority, const char *file, int line, const char *format, ...)
86 volume_id_log_fn_t volume_id_log_fn = default_log;
89 * volume_id_get_label:
92 * Lookup the probing function for a specific type.
94 * Returns: The probing function for the given type, #NULL otherwise.
96 const volume_id_probe_fn_t *volume_id_get_prober_by_type(const char *type)
103 for (p = 0; p < ARRAY_SIZE(prober_raid); p++)
104 for (n = 0; prober_raid[p].name[n] != NULL; n++)
105 if (strcmp(type, prober_raid[p].name[n]) == 0)
106 return &prober_raid[p].prober;
107 for (p = 0; p < ARRAY_SIZE(prober_filesystem); p++)
108 for (n = 0; prober_filesystem[p].name[n] != NULL; n++)
109 if (strcmp(type, prober_filesystem[p].name[n]) == 0)
110 return &prober_filesystem[p].prober;
115 * volume_id_get_label:
116 * @id: Probing context.
117 * @label: Label string. Must not be freed by the caller.
119 * Get the label string after a successful probe. Unicode
120 * is translated to UTF-8.
122 * Returns: 1 if the value was set, 0 otherwise.
124 int volume_id_get_label(struct volume_id *id, const char **label)
130 if (id->usage_id == VOLUME_ID_UNUSED)
138 * volume_id_get_label_raw:
139 * @id: Probing context.
140 * @label: Label byte array. Must not be freed by the caller.
141 * @len: Length of raw label byte array.
143 * Get the raw label byte array after a successful probe. It may
144 * contain undecoded multibyte character streams.
146 * Returns: 1 if the value was set, 0 otherwise.
148 int volume_id_get_label_raw(struct volume_id *id, const uint8_t **label, size_t *len)
156 if (id->usage_id == VOLUME_ID_UNUSED)
159 *label = id->label_raw;
160 *len = id->label_raw_len;
165 * volume_id_get_uuid:
166 * @id: Probing context.
167 * @uuid: UUID string. Must not be freed by the caller.
169 * Get the raw UUID string after a successful probe.
171 * Returns: 1 if the value was set, 0 otherwise.
173 int volume_id_get_uuid(struct volume_id *id, const char **uuid)
179 if (id->usage_id == VOLUME_ID_UNUSED)
187 * volume_id_get_uuid_raw:
188 * @id: Probing context.
189 * @uuid: UUID byte array. Must not be freed by the caller.
190 * @len: Length of raw UUID byte array.
192 * Get the raw UUID byte array after a successful probe. It may
193 * contain unconverted endianes values.
195 * Returns: 1 if the value was set, 0 otherwise.
197 int volume_id_get_uuid_raw(struct volume_id *id, const uint8_t **uuid, size_t *len)
205 if (id->usage_id == VOLUME_ID_UNUSED)
208 *uuid = id->uuid_raw;
209 *len = id->uuid_raw_len;
214 * volume_id_get_usage:
215 * @id: Probing context.
216 * @usage: Usage string. Must not be freed by the caller.
218 * Get the usage string after a successful probe.
220 * Returns: 1 if the value was set, 0 otherwise.
222 int volume_id_get_usage(struct volume_id *id, const char **usage)
228 if (id->usage_id == VOLUME_ID_UNUSED)
236 * volume_id_get_type:
237 * @id: Probing context
238 * @type: Type string. Must not be freed by the caller.
240 * Get the type string after a successful probe.
242 * Returns: 1 if the value was set, 0 otherwise.
244 int volume_id_get_type(struct volume_id *id, const char **type)
250 if (id->usage_id == VOLUME_ID_UNUSED)
258 * volume_id_get_type_version:
259 * @id: Probing context.
260 * @type_version: Type version string. Must not be freed by the caller.
262 * Get the Type version string after a successful probe.
264 * Returns: 1 if the value was set, 0 otherwise.
266 int volume_id_get_type_version(struct volume_id *id, const char **type_version)
270 if (type_version == NULL)
272 if (id->usage_id == VOLUME_ID_UNUSED)
275 *type_version = id->type_version;
279 static int needs_encoding(const char c)
281 if ((c >= '0' && c <= '9') ||
282 (c >= 'A' && c <= 'Z') ||
283 (c >= 'a' && c <= 'z') ||
284 strchr(ALLOWED_CHARS, c))
290 * volume_id_encode_string:
291 * @str: Input string to be encoded.
292 * @str_enc: Target string to store the encoded input.
293 * @len: Location to store the encoded string. The target string,
294 * which may be four times as long as the input string.
296 * Encode all potentially unsafe characters of a string to the
297 * corresponding hex value prefixed by '\x'.
299 * Returns: 1 if the entire string was copied, 0 otherwise.
301 int volume_id_encode_string(const char *str, char *str_enc, size_t len)
305 if (str == NULL || str_enc == NULL || len == 0)
309 for (i = 0, j = 0; str[i] != '\0'; i++) {
312 seqlen = volume_id_utf8_encoded_valid_unichar(&str[i]);
314 memcpy(&str_enc[j], &str[i], seqlen);
317 } else if (str[i] == '\\' || needs_encoding(str[i])) {
318 sprintf(&str_enc[j], "\\x%02x", (unsigned char) str[i]);
334 * volume_id_probe_raid:
335 * @id: Probing context.
336 * @off: Probing offset relative to the start of the device.
337 * @size: Total size of the device.
339 * Probe device for all known raid signatures.
341 * Returns: 0 on successful probe, otherwise negative value.
343 int volume_id_probe_raid(struct volume_id *id, uint64_t off, uint64_t size)
350 info("probing at offset 0x%llx, size 0x%llx",
351 (unsigned long long) off, (unsigned long long) size);
353 for (i = 0; i < ARRAY_SIZE(prober_raid); i++)
354 if (prober_raid[i].prober(id, off, size) == 0)
359 /* If recognized, we free the allocated buffers */
360 volume_id_free_buffer(id);
365 * volume_id_probe_filesystem:
366 * @id: Probing context.
367 * @off: Probing offset relative to the start of the device.
368 * @size: Total size of the device.
370 * Probe device for all known filesystem signatures.
372 * Returns: 0 on successful probe, otherwise negative value.
374 int volume_id_probe_filesystem(struct volume_id *id, uint64_t off, uint64_t size)
381 info("probing at offset 0x%llx, size 0x%llx",
382 (unsigned long long) off, (unsigned long long) size);
384 for (i = 0; i < ARRAY_SIZE(prober_filesystem); i++)
385 if (prober_filesystem[i].prober(id, off, size) == 0)
390 /* If recognized, we free the allocated buffers */
391 volume_id_free_buffer(id);
396 * volume_id_probe_all:
397 * @id: Probing context.
398 * @off: Probing offset relative to the start of the device.
399 * @size: Total size of the device.
401 * Probe device for all known raid and filesystem signatures.
403 * Returns: 0 on successful probe, otherwise negative value.
405 int volume_id_probe_all(struct volume_id *id, uint64_t off, uint64_t size)
410 /* probe for raid first, because fs probes may be successful on raid members */
411 if (volume_id_probe_raid(id, off, size) == 0)
414 if (volume_id_probe_filesystem(id, off, size) == 0)
421 * volume_id_probe_raid:
422 * @all_probers_fn: prober function to called for all known probing routines.
423 * @id: Context passed to prober function.
424 * @off: Offset value passed to prober function.
425 * @size: Size value passed to prober function.
426 * @data: Arbitrary data passed to the prober function.
428 * Run a custom function for all known probing routines.
430 void volume_id_all_probers(all_probers_fn_t all_probers_fn,
431 struct volume_id *id, uint64_t off, uint64_t size,
436 if (all_probers_fn == NULL)
439 for (i = 0; i < ARRAY_SIZE(prober_raid); i++)
440 if (all_probers_fn(prober_raid[i].prober, id, off, size, data) != 0)
442 for (i = 0; i < ARRAY_SIZE(prober_filesystem); i++)
443 if (all_probers_fn(prober_filesystem[i].prober, id, off, size, data) != 0)
451 * @id: Probing context.
452 * @fd: Open file descriptor of device to read from.
454 * Create the context for probing.
456 * Returns: Probing context, or #NULL on failure.
458 struct volume_id *volume_id_open_fd(int fd)
460 struct volume_id *id;
462 id = malloc(sizeof(struct volume_id));
465 memset(id, 0x00, sizeof(struct volume_id));
472 struct volume_id *volume_id_open_node(const char *path)
474 struct volume_id *id;
477 fd = open(path, O_RDONLY);
479 dbg("unable to open '%s'", path);
483 id = volume_id_open_fd(fd);
487 /* close fd on device close */
495 * @id: Probing context.
497 * Release probing context and free all associated data.
499 void volume_id_close(struct volume_id *id)
504 if (id->fd_close != 0)
507 volume_id_free_buffer(id);