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