extras/volume_id/lib/libvolume_id-private.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_PRIVATE_H_
  12 #define _LIBVOLUME_ID_PRIVATE_H_
  13
  14 #include <stdint.h>
  15 #include <stddef.h>
  16 #include <endian.h>
  17 #include <byteswap.h>
  18 #include <syslog.h>
  19
  20 #include "libvolume_id.h"
  21
  22 #define ALLOWED_CHARS                   "#+-.:=@_"
  23
  24 #ifndef PACKED
  25 #define PACKED                          __attribute__((packed))
  26 #endif
  27
  28 #define err(format, arg...)     volume_id_log_fn(LOG_ERR, __FILE__, __LINE__, format, ##arg)
  29 #define info(format, arg...)    volume_id_log_fn(LOG_INFO, __FILE__, __LINE__, format, ##arg)
  30 #ifdef DEBUG
  31 #define dbg(format, arg...)     volume_id_log_fn(LOG_DEBUG, __FILE__, __LINE__, format, ##arg)
  32 #else
  33 #define dbg(format, arg...)     do { } while (0)
  34 #endif
  35
  36 #if (__BYTE_ORDER == __LITTLE_ENDIAN)
  37 #define le16_to_cpu(x) (x)
  38 #define le32_to_cpu(x) (x)
  39 #define le64_to_cpu(x) (x)
  40 #define be16_to_cpu(x) bswap_16(x)
  41 #define be32_to_cpu(x) bswap_32(x)
  42 #define cpu_to_le16(x) (x)
  43 #define cpu_to_le32(x) (x)
  44 #define cpu_to_be32(x) bswap_32(x)
  45 #elif (__BYTE_ORDER == __BIG_ENDIAN)
  46 #define le16_to_cpu(x) bswap_16(x)
  47 #define le32_to_cpu(x) bswap_32(x)
  48 #define le64_to_cpu(x) bswap_64(x)
  49 #define be16_to_cpu(x) (x)
  50 #define be32_to_cpu(x) (x)
  51 #define cpu_to_le16(x) bswap_16(x)
  52 #define cpu_to_le32(x) bswap_32(x)
  53 #define cpu_to_be32(x) (x)
  54 #endif /* __BYTE_ORDER */
  55
  56 enum uuid_format {
  57         UUID_STRING,
  58         UUID_HEX_STRING,
  59         UUID_DCE,
  60         UUID_DOS,
  61         UUID_64BIT_LE,
  62         UUID_MD,
  63         UUID_LVM,
  64 };
  65
  66 enum endian {
  67         LE = 0,
  68         BE = 1
  69 };
  70
  71 #define VOLUME_ID_LABEL_SIZE                    64
  72 #define VOLUME_ID_UUID_SIZE                     36
  73 #define VOLUME_ID_FORMAT_SIZE                   32
  74 #define VOLUME_ID_PATH_MAX                      256
  75 #define VOLUME_ID_PARTITIONS_MAX                256
  76
  77 /* size of superblock buffer, reiserfs block is at 64k */
  78 #define SB_BUFFER_SIZE                          0x11000
  79 /* size of seek buffer, FAT cluster is 32k max */
  80 #define SEEK_BUFFER_SIZE                        0x10000
  81
  82 enum volume_id_usage {
  83         VOLUME_ID_UNUSED,
  84         VOLUME_ID_UNPROBED,
  85         VOLUME_ID_OTHER,
  86         VOLUME_ID_FILESYSTEM,
  87         VOLUME_ID_RAID,
  88         VOLUME_ID_DISKLABEL,
  89         VOLUME_ID_CRYPTO,
  90 };
  91
  92 struct volume_id {
  93         uint8_t         label_raw[VOLUME_ID_LABEL_SIZE];
  94         size_t          label_raw_len;
  95         char            label[VOLUME_ID_LABEL_SIZE+1];
  96         uint8_t         uuid_raw[VOLUME_ID_UUID_SIZE];
  97         size_t          uuid_raw_len;
  98         char            uuid[VOLUME_ID_UUID_SIZE+1];
  99         enum            volume_id_usage usage_id;
 100         char            *usage;
 101         char            *type;
 102         char            type_version[VOLUME_ID_FORMAT_SIZE];
 103
 104         int             fd;
 105         uint8_t         *sbbuf;
 106         size_t          sbbuf_len;
 107         uint8_t         *seekbuf;
 108         uint64_t        seekbuf_off;
 109         size_t          seekbuf_len;
 110 };
 111
 112 /* utils */
 113 extern int volume_id_utf8_encoded_valid_unichar(const char *str);
 114 extern size_t volume_id_set_unicode16(uint8_t *str, size_t len, const uint8_t *buf, enum endian endianess, size_t count);
 115 extern void volume_id_set_usage(struct volume_id *id, enum volume_id_usage usage_id);
 116 extern void volume_id_set_label_raw(struct volume_id *id, const uint8_t *buf, size_t count);
 117 extern void volume_id_set_label_string(struct volume_id *id, const uint8_t *buf, size_t count);
 118 extern void volume_id_set_label_unicode16(struct volume_id *id, const uint8_t *buf, enum endian endianess, size_t count);
 119 extern void volume_id_set_uuid(struct volume_id *id, const uint8_t *buf, size_t len, enum uuid_format format);
 120 extern uint8_t *volume_id_get_buffer(struct volume_id *id, uint64_t off, size_t len);
 121 extern void volume_id_free_buffer(struct volume_id *id);
 122
 123 /* filesystems */
 124 extern int volume_id_probe_cramfs(struct volume_id *id, uint64_t off, uint64_t size);
 125 extern int volume_id_probe_ext(struct volume_id *id, uint64_t off, uint64_t size);
 126 extern int volume_id_probe_vfat(struct volume_id *id, uint64_t off, uint64_t size);
 127 extern int volume_id_probe_hfs_hfsplus(struct volume_id *id, uint64_t off, uint64_t size);
 128 extern int volume_id_probe_hpfs(struct volume_id *id, uint64_t off, uint64_t size);
 129 extern int volume_id_probe_iso9660(struct volume_id *id, uint64_t off, uint64_t size);
 130 extern int volume_id_probe_jfs(struct volume_id *id, uint64_t off, uint64_t size);
 131 extern int volume_id_probe_minix(struct volume_id *id, uint64_t off, uint64_t size);
 132 extern int volume_id_probe_ntfs(struct volume_id *id, uint64_t off, uint64_t size);
 133 extern int volume_id_probe_ocfs1(struct volume_id *id, uint64_t off, uint64_t size);
 134 extern int volume_id_probe_ocfs2(struct volume_id *id, uint64_t off, uint64_t size);
 135 extern int volume_id_probe_reiserfs(struct volume_id *id, uint64_t off, uint64_t size);
 136 extern int volume_id_probe_romfs(struct volume_id *id, uint64_t off, uint64_t size);
 137 extern int volume_id_probe_sysv(struct volume_id *id, uint64_t off, uint64_t size);
 138 extern int volume_id_probe_udf(struct volume_id *id, uint64_t off, uint64_t size);
 139 extern int volume_id_probe_ufs(struct volume_id *id, uint64_t off, uint64_t size);
 140 extern int volume_id_probe_vxfs(struct volume_id *id, uint64_t off, uint64_t size);
 141 extern int volume_id_probe_xfs(struct volume_id *id, uint64_t off, uint64_t size);
 142 extern int volume_id_probe_squashfs(struct volume_id *id, uint64_t off, uint64_t size);
 143 extern int volume_id_probe_netware(struct volume_id *id, uint64_t off, uint64_t size);
 144 extern int volume_id_probe_gfs(struct volume_id *id, uint64_t off, uint64_t size);
 145 extern int volume_id_probe_gfs2(struct volume_id *id, uint64_t off, uint64_t size);
 146
 147 /* special formats */
 148 extern int volume_id_probe_linux_swap(struct volume_id *id, uint64_t off, uint64_t size);
 149 extern int volume_id_probe_luks(struct volume_id *id, uint64_t off, uint64_t size);
 150
 151 /* raid */
 152 extern int volume_id_probe_linux_raid(struct volume_id *id, uint64_t off, uint64_t size);
 153 extern int volume_id_probe_lvm1(struct volume_id *id, uint64_t off, uint64_t size);
 154 extern int volume_id_probe_lvm2(struct volume_id *id, uint64_t off, uint64_t size);
 155 extern int volume_id_probe_ddf_raid(struct volume_id *id, uint64_t off, uint64_t size);
 156 extern int volume_id_probe_oracleasm(struct volume_id *id, uint64_t off, uint64_t size);
 157
 158 /* bios raid */
 159 extern int volume_id_probe_intel_software_raid(struct volume_id *id, uint64_t off, uint64_t size);
 160 extern int volume_id_probe_highpoint_37x_raid(struct volume_id *id, uint64_t off, uint64_t size);
 161 extern int volume_id_probe_highpoint_45x_raid(struct volume_id *id, uint64_t off, uint64_t size);
 162 extern int volume_id_probe_lsi_mega_raid(struct volume_id *id, uint64_t off, uint64_t size);
 163 extern int volume_id_probe_nvidia_raid(struct volume_id *id, uint64_t off, uint64_t size);
 164 extern int volume_id_probe_promise_fasttrack_raid(struct volume_id *id, uint64_t off, uint64_t size);
 165 extern int volume_id_probe_silicon_medley_raid(struct volume_id *id, uint64_t off, uint64_t size);
 166 extern int volume_id_probe_via_raid(struct volume_id *id, uint64_t off, uint64_t size);
 167 extern int volume_id_probe_adaptec_raid(struct volume_id *id, uint64_t off, uint64_t size);
 168 extern int volume_id_probe_jmicron_raid(struct volume_id *id, uint64_t off, uint64_t size);
 169
 170 #endif