extras/volume_id/lib/libvolume_id.h

   1 /*
   2  * volume_id - reads volume label and uuid
   3  *
   4  * Copyright (C) 2005-2007 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   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.
   9  */
  10
  11 #ifndef _LIBVOLUME_ID_H_
  12 #define _LIBVOLUME_ID_H_
  13
  14 #include <stdint.h>
  15 #include <stddef.h>
  16
  17 typedef void (*volume_id_log_fn_t)(int priority, const char *file, int line, const char *format, ...)
  18              __attribute__ ((format(printf, 4, 5)));
  19
  20 extern volume_id_log_fn_t volume_id_log_fn;
  21
  22 #define VOLUME_ID_LABEL_SIZE            64
  23 #define VOLUME_ID_UUID_SIZE             36
  24 #define VOLUME_ID_FORMAT_SIZE           32
  25 #define VOLUME_ID_PATH_MAX              256
  26 #define VOLUME_ID_PARTITIONS_MAX        256
  27
  28 enum volume_id_usage {
  29         VOLUME_ID_UNUSED,
  30         VOLUME_ID_UNPROBED,
  31         VOLUME_ID_OTHER,
  32         VOLUME_ID_FILESYSTEM,
  33         VOLUME_ID_RAID,
  34         VOLUME_ID_DISKLABEL,
  35         VOLUME_ID_CRYPTO,
  36 };
  37
  38 struct volume_id {
  39         uint8_t         label_raw[VOLUME_ID_LABEL_SIZE];
  40         size_t          label_raw_len;
  41         char            label[VOLUME_ID_LABEL_SIZE+1];
  42         uint8_t         uuid_raw[VOLUME_ID_UUID_SIZE];
  43         size_t          uuid_raw_len;
  44         char            uuid[VOLUME_ID_UUID_SIZE+1];
  45         enum            volume_id_usage usage_id;
  46         char            *usage;
  47         char            *type;
  48         char            type_version[VOLUME_ID_FORMAT_SIZE];
  49
  50         int             fd;
  51         uint8_t         *sbbuf;
  52         size_t          sbbuf_len;
  53         uint8_t         *seekbuf;
  54         uint64_t        seekbuf_off;
  55         size_t          seekbuf_len;
  56         int             fd_close:1;
  57 };
  58
  59 extern int volume_id_get_label(struct volume_id *id, const char **label);
  60 extern int volume_id_get_label_raw(struct volume_id *id, const uint8_t **label, size_t *len);
  61 extern int volume_id_get_uuid(struct volume_id *id, const char **uuid);
  62 extern int volume_id_get_uuid_raw(struct volume_id *id, const uint8_t **uuid, size_t *len);
  63 extern int volume_id_get_usage(struct volume_id *id, const char **usage);
  64 extern int volume_id_get_type(struct volume_id *id, const char **type);
  65 extern int volume_id_get_type_version(struct volume_id *id, const char **type_version);
  66
  67 extern struct volume_id *volume_id_open_fd(int fd);
  68 extern struct volume_id *volume_id_open_node(const char *path);
  69 extern int volume_id_probe_all(struct volume_id *id, uint64_t off, uint64_t size);
  70 extern int volume_id_probe_filesystem(struct volume_id *id, uint64_t off, uint64_t size);
  71 extern int volume_id_probe_raid(struct volume_id *id, uint64_t off, uint64_t size);
  72 extern void volume_id_close(struct volume_id *id);
  73
  74 /* filesystems */
  75 extern int volume_id_probe_cramfs(struct volume_id *id, uint64_t off, uint64_t size);
  76 extern int volume_id_probe_ext(struct volume_id *id, uint64_t off, uint64_t size);
  77 extern int volume_id_probe_vfat(struct volume_id *id, uint64_t off, uint64_t size);
  78 extern int volume_id_probe_hfs_hfsplus(struct volume_id *id, uint64_t off, uint64_t size);
  79 extern int volume_id_probe_hpfs(struct volume_id *id, uint64_t off, uint64_t size);
  80 extern int volume_id_probe_iso9660(struct volume_id *id, uint64_t off, uint64_t size);
  81 extern int volume_id_probe_jfs(struct volume_id *id, uint64_t off, uint64_t size);
  82 extern int volume_id_probe_minix(struct volume_id *id, uint64_t off, uint64_t size);
  83 extern int volume_id_probe_ntfs(struct volume_id *id, uint64_t off, uint64_t size);
  84 extern int volume_id_probe_ocfs1(struct volume_id *id, uint64_t off, uint64_t size);
  85 extern int volume_id_probe_ocfs2(struct volume_id *id, uint64_t off, uint64_t size);
  86 extern int volume_id_probe_reiserfs(struct volume_id *id, uint64_t off, uint64_t size);
  87 extern int volume_id_probe_romfs(struct volume_id *id, uint64_t off, uint64_t size);
  88 extern int volume_id_probe_sysv(struct volume_id *id, uint64_t off, uint64_t size);
  89 extern int volume_id_probe_udf(struct volume_id *id, uint64_t off, uint64_t size);
  90 extern int volume_id_probe_ufs(struct volume_id *id, uint64_t off, uint64_t size);
  91 extern int volume_id_probe_vxfs(struct volume_id *id, uint64_t off, uint64_t size);
  92 extern int volume_id_probe_xfs(struct volume_id *id, uint64_t off, uint64_t size);
  93 extern int volume_id_probe_squashfs(struct volume_id *id, uint64_t off, uint64_t size);
  94 extern int volume_id_probe_netware(struct volume_id *id, uint64_t off, uint64_t size);
  95 extern int volume_id_probe_gfs(struct volume_id *id, uint64_t off, uint64_t size);
  96 extern int volume_id_probe_gfs2(struct volume_id *id, uint64_t off, uint64_t size);
  97
  98 /* special formats */
  99 extern int volume_id_probe_linux_swap(struct volume_id *id, uint64_t off, uint64_t size);
 100 extern int volume_id_probe_luks(struct volume_id *id, uint64_t off, uint64_t size);
 101
 102 /* raid */
 103 extern int volume_id_probe_linux_raid(struct volume_id *id, uint64_t off, uint64_t size);
 104 extern int volume_id_probe_lvm1(struct volume_id *id, uint64_t off, uint64_t size);
 105 extern int volume_id_probe_lvm2(struct volume_id *id, uint64_t off, uint64_t size);
 106
 107 /* bios raid */
 108 extern int volume_id_probe_intel_software_raid(struct volume_id *id, uint64_t off, uint64_t size);
 109 extern int volume_id_probe_highpoint_37x_raid(struct volume_id *id, uint64_t off, uint64_t size);
 110 extern int volume_id_probe_highpoint_45x_raid(struct volume_id *id, uint64_t off, uint64_t size);
 111 extern int volume_id_probe_lsi_mega_raid(struct volume_id *id, uint64_t off, uint64_t size);
 112 extern int volume_id_probe_nvidia_raid(struct volume_id *id, uint64_t off, uint64_t size);
 113 extern int volume_id_probe_promise_fasttrack_raid(struct volume_id *id, uint64_t off, uint64_t size);
 114 extern int volume_id_probe_silicon_medley_raid(struct volume_id *id, uint64_t off, uint64_t size);
 115 extern int volume_id_probe_via_raid(struct volume_id *id, uint64_t off, uint64_t size);
 116 extern int volume_id_probe_adaptec_raid(struct volume_id *id, uint64_t off, uint64_t size);
 117 extern int volume_id_probe_jmicron_raid(struct volume_id *id, uint64_t off, uint64_t size);
 118
 119 #endif