5a38562f416935c9e6965929e03e32d21184325c
[oweals/busybox.git] / 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
25 #define dbg(...) ((void)0)
26
27
28 /* volume_id.h */
29
30 #define VOLUME_ID_VERSION               48
31
32 #define VOLUME_ID_LABEL_SIZE            64
33 #define VOLUME_ID_UUID_SIZE             36
34 #define VOLUME_ID_FORMAT_SIZE           32
35 #define VOLUME_ID_PARTITIONS_MAX        256
36
37 enum volume_id_usage {
38         VOLUME_ID_UNUSED,
39         VOLUME_ID_UNPROBED,
40         VOLUME_ID_OTHER,
41         VOLUME_ID_FILESYSTEM,
42         VOLUME_ID_PARTITIONTABLE,
43         VOLUME_ID_RAID,
44         VOLUME_ID_DISKLABEL,
45         VOLUME_ID_CRYPTO,
46 };
47
48 struct volume_id_partition {
49         enum            volume_id_usage usage_id;
50         const char      *usage;
51         const char      *type;
52         uint64_t        off;
53         uint64_t        len;
54         uint8_t         partition_type_raw;
55 };
56
57 struct volume_id {
58         uint8_t         label_raw[VOLUME_ID_LABEL_SIZE];
59         size_t          label_raw_len;
60         char            label[VOLUME_ID_LABEL_SIZE+1];
61         uint8_t         uuid_raw[VOLUME_ID_UUID_SIZE];
62         size_t          uuid_raw_len;
63         char            uuid[VOLUME_ID_UUID_SIZE+1];
64         enum            volume_id_usage usage_id;
65         const char      *usage;
66         const char      *type;
67         char            type_version[VOLUME_ID_FORMAT_SIZE];
68
69         struct volume_id_partition *partitions;
70         size_t          partition_count;
71
72         int             fd;
73         uint8_t         *sbbuf;
74         uint8_t         *seekbuf;
75         size_t          sbbuf_len;
76         uint64_t        seekbuf_off;
77         size_t          seekbuf_len;
78 //      int             fd_close:1;
79 };
80
81 struct volume_id *volume_id_open_node(const char *path);
82 int volume_id_probe_all(struct volume_id *id, uint64_t off, uint64_t size);
83 void free_volume_id(struct volume_id *id);
84
85 /* util.h */
86
87 /* size of superblock buffer, reiserfs block is at 64k */
88 #define SB_BUFFER_SIZE                          0x11000
89 /* size of seek buffer, FAT cluster is 32k max */
90 #define SEEK_BUFFER_SIZE                        0x10000
91
92 #define bswap16(x) (uint16_t)   ( \
93                                 (((uint16_t)(x) & 0x00ffu) << 8) | \
94                                 (((uint16_t)(x) & 0xff00u) >> 8))
95
96 #define bswap32(x) (uint32_t)   ( \
97                                 (((uint32_t)(x) & 0xff000000u) >> 24) | \
98                                 (((uint32_t)(x) & 0x00ff0000u) >>  8) | \
99                                 (((uint32_t)(x) & 0x0000ff00u) <<  8) | \
100                                 (((uint32_t)(x) & 0x000000ffu) << 24))
101
102 #define bswap64(x) (uint64_t)   ( \
103                                 (((uint64_t)(x) & 0xff00000000000000ull) >> 56) | \
104                                 (((uint64_t)(x) & 0x00ff000000000000ull) >> 40) | \
105                                 (((uint64_t)(x) & 0x0000ff0000000000ull) >> 24) | \
106                                 (((uint64_t)(x) & 0x000000ff00000000ull) >>  8) | \
107                                 (((uint64_t)(x) & 0x00000000ff000000ull) <<  8) | \
108                                 (((uint64_t)(x) & 0x0000000000ff0000ull) << 24) | \
109                                 (((uint64_t)(x) & 0x000000000000ff00ull) << 40) | \
110                                 (((uint64_t)(x) & 0x00000000000000ffull) << 56))
111
112 #if BB_LITTLE_ENDIAN
113 #define le16_to_cpu(x) (x)
114 #define le32_to_cpu(x) (x)
115 #define le64_to_cpu(x) (x)
116 #define be16_to_cpu(x) bswap16(x)
117 #define be32_to_cpu(x) bswap32(x)
118 #define cpu_to_le16(x) (x)
119 #define cpu_to_le32(x) (x)
120 #define cpu_to_be32(x) bswap32(x)
121 #else
122 #define le16_to_cpu(x) bswap16(x)
123 #define le32_to_cpu(x) bswap32(x)
124 #define le64_to_cpu(x) bswap64(x)
125 #define be16_to_cpu(x) (x)
126 #define be32_to_cpu(x) (x)
127 #define cpu_to_le16(x) bswap16(x)
128 #define cpu_to_le32(x) bswap32(x)
129 #define cpu_to_be32(x) (x)
130 #endif
131
132 enum uuid_format {
133         UUID_DCE_STRING,
134         UUID_DCE,
135         UUID_DOS,
136         UUID_NTFS,
137         UUID_HFS,
138 };
139
140 enum endian {
141         LE = 0,
142         BE = 1
143 };
144
145 void volume_id_set_unicode16(char *str, size_t len, const uint8_t *buf, enum endian endianess, size_t count);
146 void volume_id_set_usage(struct volume_id *id, enum volume_id_usage usage_id);
147 void volume_id_set_usage_part(struct volume_id_partition *part, enum volume_id_usage usage_id);
148 void volume_id_set_label_raw(struct volume_id *id, const uint8_t *buf, size_t count);
149 void volume_id_set_label_string(struct volume_id *id, const uint8_t *buf, size_t count);
150 void volume_id_set_label_unicode16(struct volume_id *id, const uint8_t *buf, enum endian endianess, size_t count);
151 void volume_id_set_uuid(struct volume_id *id, const uint8_t *buf, enum uuid_format format);
152 void *volume_id_get_buffer(struct volume_id *id, uint64_t off, size_t len);
153 void volume_id_free_buffer(struct volume_id *id);
154
155
156 /* Probe routines */
157
158 /* RAID */
159
160 int volume_id_probe_highpoint_37x_raid(struct volume_id *id, uint64_t off);
161 int volume_id_probe_highpoint_45x_raid(struct volume_id *id, uint64_t off, uint64_t size);
162
163 int volume_id_probe_intel_software_raid(struct volume_id *id, uint64_t off, uint64_t size);
164
165 int volume_id_probe_linux_raid(struct volume_id *id, uint64_t off, uint64_t size);
166
167 int volume_id_probe_lsi_mega_raid(struct volume_id *id, uint64_t off, uint64_t size);
168
169 int volume_id_probe_nvidia_raid(struct volume_id *id, uint64_t off, uint64_t size);
170
171 int volume_id_probe_promise_fasttrack_raid(struct volume_id *id, uint64_t off, uint64_t size);
172
173 int volume_id_probe_silicon_medley_raid(struct volume_id *id, uint64_t off, uint64_t size);
174
175 int volume_id_probe_via_raid(struct volume_id *id, uint64_t off, uint64_t size);
176
177 int volume_id_probe_lvm1(struct volume_id *id, uint64_t off);
178 int volume_id_probe_lvm2(struct volume_id *id, uint64_t off);
179
180 /* FS */
181
182 int volume_id_probe_cramfs(struct volume_id *id, uint64_t off);
183
184 int volume_id_probe_ext(struct volume_id *id, uint64_t off);
185
186 int volume_id_probe_vfat(struct volume_id *id, uint64_t off);
187
188 int volume_id_probe_hfs_hfsplus(struct volume_id *id, uint64_t off);
189
190 int volume_id_probe_hpfs(struct volume_id *id, uint64_t off);
191
192 int volume_id_probe_iso9660(struct volume_id *id, uint64_t off);
193
194 int volume_id_probe_jfs(struct volume_id *id, uint64_t off);
195
196 int volume_id_probe_linux_swap(struct volume_id *id, uint64_t off);
197
198 int volume_id_probe_luks(struct volume_id *id, uint64_t off);
199
200 int volume_id_probe_mac_partition_map(struct volume_id *id, uint64_t off);
201
202 int volume_id_probe_minix(struct volume_id *id, uint64_t off);
203
204 int volume_id_probe_msdos_part_table(struct volume_id *id, uint64_t off);
205
206 int volume_id_probe_ntfs(struct volume_id *id, uint64_t off);
207
208 int volume_id_probe_ocfs2(struct volume_id *id, uint64_t off);
209
210 int volume_id_probe_reiserfs(struct volume_id *id, uint64_t off);
211
212 int volume_id_probe_romfs(struct volume_id *id, uint64_t off);
213
214 int volume_id_probe_sysv(struct volume_id *id, uint64_t off);
215
216 int volume_id_probe_udf(struct volume_id *id, uint64_t off);
217
218 int volume_id_probe_ufs(struct volume_id *id, uint64_t off);
219
220 int volume_id_probe_xfs(struct volume_id *id, uint64_t off);