util-linux/volume_id/volume_id_internal.h

   1 /*
   2  * volume_id - reads filesystem label and uuid
   3  *
   4  * Copyright (C) 2005 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  *      This library is free software; you can redistribute it and/or
   7  *      modify it under the terms of the GNU Lesser General Public
   8  *      License as published by the Free Software Foundation; either
   9  *      version 2.1 of the License, or (at your option) any later version.
  10  *
  11  *      This library is distributed in the hope that it will be useful,
  12  *      but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  *      Lesser General Public License for more details.
  15  *
  16  *      You should have received a copy of the GNU Lesser General Public
  17  *      License along with this library; if not, write to the Free Software
  18  *      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 #include "libbb.h"
  22 #include "volume_id.h"
  23
  24 #if __GNUC_PREREQ(4,1)
  25 # pragma GCC visibility push(hidden)
  26 #endif
  27
  28 #define dbg(...) ((void)0)
  29 /* #define dbg(...) bb_error_msg(__VA_ARGS__) */
  30
  31
  32 /* volume_id.h */
  33
  34 #define VOLUME_ID_VERSION               48
  35
  36 #define VOLUME_ID_LABEL_SIZE            64
  37 #define VOLUME_ID_UUID_SIZE             36
  38 #define VOLUME_ID_FORMAT_SIZE           32
  39 #define VOLUME_ID_PARTITIONS_MAX        256
  40
  41 enum volume_id_usage {
  42         VOLUME_ID_UNUSED,
  43         VOLUME_ID_UNPROBED,
  44         VOLUME_ID_OTHER,
  45         VOLUME_ID_FILESYSTEM,
  46         VOLUME_ID_PARTITIONTABLE,
  47         VOLUME_ID_RAID,
  48         VOLUME_ID_DISKLABEL,
  49         VOLUME_ID_CRYPTO,
  50 };
  51
  52 #ifdef UNUSED_PARTITION_CODE
  53 struct volume_id_partition {
  54 //      const char      *type;
  55 //      const char      *usage;
  56 //      smallint        usage_id;
  57 //      uint8_t         pt_type_raw;
  58 //      uint64_t        pt_off;
  59 //      uint64_t        pt_len;
  60 };
  61 #endif
  62
  63 struct volume_id {
  64         int             fd;
  65 //      int             fd_close:1;
  66         size_t          sbbuf_len;
  67         size_t          seekbuf_len;
  68         uint8_t         *sbbuf;
  69         uint8_t         *seekbuf;
  70         uint64_t        seekbuf_off;
  71 #ifdef UNUSED_PARTITION_CODE
  72         struct volume_id_partition *partitions;
  73         size_t          partition_count;
  74 #endif
  75 //      uint8_t         label_raw[VOLUME_ID_LABEL_SIZE];
  76 //      size_t          label_raw_len;
  77         char            label[VOLUME_ID_LABEL_SIZE+1];
  78 //      uint8_t         uuid_raw[VOLUME_ID_UUID_SIZE];
  79 //      size_t          uuid_raw_len;
  80         /* uuid is stored in ASCII (not binary) form here: */
  81         char            uuid[VOLUME_ID_UUID_SIZE+1];
  82 //      char            type_version[VOLUME_ID_FORMAT_SIZE];
  83 //      smallint        usage_id;
  84 //      const char      *usage;
  85 //      const char      *type;
  86 };
  87
  88 struct volume_id *volume_id_open_node(int fd);
  89 int volume_id_probe_all(struct volume_id *id, uint64_t off, uint64_t size);
  90 void free_volume_id(struct volume_id *id);
  91
  92 /* util.h */
  93
  94 /* size of superblock buffer, reiserfs block is at 64k */
  95 #define SB_BUFFER_SIZE                          0x11000
  96 /* size of seek buffer, FAT cluster is 32k max */
  97 #define SEEK_BUFFER_SIZE                        0x10000
  98
  99 #define bswap16(x) (uint16_t)   ( \
 100                                 (((uint16_t)(x) & 0x00ffu) << 8) | \
 101                                 (((uint16_t)(x) & 0xff00u) >> 8))
 102
 103 #define bswap32(x) (uint32_t)   ( \
 104                                 (((uint32_t)(x) & 0xff000000u) >> 24) | \
 105                                 (((uint32_t)(x) & 0x00ff0000u) >>  8) | \
 106                                 (((uint32_t)(x) & 0x0000ff00u) <<  8) | \
 107                                 (((uint32_t)(x) & 0x000000ffu) << 24))
 108
 109 #define bswap64(x) (uint64_t)   ( \
 110                                 (((uint64_t)(x) & 0xff00000000000000ull) >> 56) | \
 111                                 (((uint64_t)(x) & 0x00ff000000000000ull) >> 40) | \
 112                                 (((uint64_t)(x) & 0x0000ff0000000000ull) >> 24) | \
 113                                 (((uint64_t)(x) & 0x000000ff00000000ull) >>  8) | \
 114                                 (((uint64_t)(x) & 0x00000000ff000000ull) <<  8) | \
 115                                 (((uint64_t)(x) & 0x0000000000ff0000ull) << 24) | \
 116                                 (((uint64_t)(x) & 0x000000000000ff00ull) << 40) | \
 117                                 (((uint64_t)(x) & 0x00000000000000ffull) << 56))
 118
 119 #if BB_LITTLE_ENDIAN
 120 #define le16_to_cpu(x) (x)
 121 #define le32_to_cpu(x) (x)
 122 #define le64_to_cpu(x) (x)
 123 #define be16_to_cpu(x) bswap16(x)
 124 #define be32_to_cpu(x) bswap32(x)
 125 #define cpu_to_le16(x) (x)
 126 #define cpu_to_le32(x) (x)
 127 #define cpu_to_be32(x) bswap32(x)
 128 #else
 129 #define le16_to_cpu(x) bswap16(x)
 130 #define le32_to_cpu(x) bswap32(x)
 131 #define le64_to_cpu(x) bswap64(x)
 132 #define be16_to_cpu(x) (x)
 133 #define be32_to_cpu(x) (x)
 134 #define cpu_to_le16(x) bswap16(x)
 135 #define cpu_to_le32(x) bswap32(x)
 136 #define cpu_to_be32(x) (x)
 137 #endif
 138
 139 enum uuid_format {
 140         UUID_DCE_STRING,
 141         UUID_DCE,
 142         UUID_DOS,
 143         UUID_NTFS,
 144         UUID_HFS,
 145 };
 146
 147 enum endian {
 148         LE = 0,
 149         BE = 1
 150 };
 151
 152 void volume_id_set_unicode16(char *str, size_t len, const uint8_t *buf, enum endian endianess, size_t count);
 153 //void volume_id_set_usage(struct volume_id *id, enum volume_id_usage usage_id);
 154 //void volume_id_set_usage_part(struct volume_id_partition *part, enum volume_id_usage usage_id);
 155 //void volume_id_set_label_raw(struct volume_id *id, const uint8_t *buf, size_t count);
 156 void volume_id_set_label_string(struct volume_id *id, const uint8_t *buf, size_t count);
 157 void volume_id_set_label_unicode16(struct volume_id *id, const uint8_t *buf, enum endian endianess, size_t count);
 158 void volume_id_set_uuid(struct volume_id *id, const uint8_t *buf, enum uuid_format format);
 159 void *volume_id_get_buffer(struct volume_id *id, uint64_t off, size_t len);
 160 void volume_id_free_buffer(struct volume_id *id);
 161
 162
 163 /* Probe routines */
 164
 165 /* RAID */
 166
 167 //int volume_id_probe_highpoint_37x_raid(struct volume_id *id, uint64_t off);
 168 //int volume_id_probe_highpoint_45x_raid(struct volume_id *id, uint64_t off, uint64_t size);
 169
 170 //int volume_id_probe_intel_software_raid(struct volume_id *id, uint64_t off, uint64_t size);
 171
 172 int volume_id_probe_linux_raid(struct volume_id *id, uint64_t off, uint64_t size);
 173
 174 //int volume_id_probe_lsi_mega_raid(struct volume_id *id, uint64_t off, uint64_t size);
 175
 176 //int volume_id_probe_nvidia_raid(struct volume_id *id, uint64_t off, uint64_t size);
 177
 178 //int volume_id_probe_promise_fasttrack_raid(struct volume_id *id, uint64_t off, uint64_t size);
 179
 180 //int volume_id_probe_silicon_medley_raid(struct volume_id *id, uint64_t off, uint64_t size);
 181
 182 //int volume_id_probe_via_raid(struct volume_id *id, uint64_t off, uint64_t size);
 183
 184 //int volume_id_probe_lvm1(struct volume_id *id, uint64_t off);
 185 //int volume_id_probe_lvm2(struct volume_id *id, uint64_t off);
 186
 187 /* FS */
 188
 189 int volume_id_probe_cramfs(struct volume_id *id, uint64_t off);
 190
 191 int volume_id_probe_ext(struct volume_id *id, uint64_t off);
 192
 193 int volume_id_probe_vfat(struct volume_id *id, uint64_t off);
 194
 195 int volume_id_probe_hfs_hfsplus(struct volume_id *id, uint64_t off);
 196
 197 //int volume_id_probe_hpfs(struct volume_id *id, uint64_t off);
 198
 199 int volume_id_probe_iso9660(struct volume_id *id, uint64_t off);
 200
 201 int volume_id_probe_jfs(struct volume_id *id, uint64_t off);
 202
 203 int volume_id_probe_linux_swap(struct volume_id *id, uint64_t off);
 204
 205 int volume_id_probe_luks(struct volume_id *id, uint64_t off);
 206
 207 //int volume_id_probe_mac_partition_map(struct volume_id *id, uint64_t off);
 208
 209 //int volume_id_probe_minix(struct volume_id *id, uint64_t off);
 210
 211 //int volume_id_probe_msdos_part_table(struct volume_id *id, uint64_t off);
 212
 213 int volume_id_probe_ntfs(struct volume_id *id, uint64_t off);
 214
 215 int volume_id_probe_ocfs2(struct volume_id *id, uint64_t off);
 216
 217 int volume_id_probe_reiserfs(struct volume_id *id, uint64_t off);
 218
 219 int volume_id_probe_romfs(struct volume_id *id, uint64_t off);
 220
 221 int volume_id_probe_sysv(struct volume_id *id, uint64_t off);
 222
 223 int volume_id_probe_udf(struct volume_id *id, uint64_t off);
 224
 225 //int volume_id_probe_ufs(struct volume_id *id, uint64_t off);
 226
 227 int volume_id_probe_xfs(struct volume_id *id, uint64_t off);
 228
 229 #if __GNUC_PREREQ(4,1)
 230 # pragma GCC visibility pop
 231 #endif