extras/volume_id/libvolume_id/libvolume_id.h

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