2 * volume_id - reads filesystem label and uuid
4 * Copyright (C) 2005-2007 Kay Sievers <kay.sievers@vrfy.org>
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.
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.
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/>.
33 #include "libvolume_id.h"
34 #include "libvolume_id-private.h"
36 /* count of characters used to encode one unicode char */
37 static int utf8_encoded_expected_len(const char *str)
39 unsigned char c = (unsigned char)str[0];
43 if ((c & 0xe0) == 0xc0)
45 if ((c & 0xf0) == 0xe0)
47 if ((c & 0xf8) == 0xf0)
49 if ((c & 0xfc) == 0xf8)
51 if ((c & 0xfe) == 0xfc)
56 /* decode one unicode char */
57 static int utf8_encoded_to_unichar(const char *str)
63 len = utf8_encoded_expected_len(str);
68 unichar = str[0] & 0x1f;
71 unichar = (int)str[0] & 0x0f;
74 unichar = (int)str[0] & 0x07;
77 unichar = (int)str[0] & 0x03;
80 unichar = (int)str[0] & 0x01;
86 for (i = 1; i < len; i++) {
87 if (((int)str[i] & 0xc0) != 0x80)
90 unichar |= (int)str[i] & 0x3f;
96 /* expected size used to encode one unicode char */
97 static int utf8_unichar_to_encoded_len(int unichar)
103 if (unichar < 0x10000)
105 if (unichar < 0x200000)
107 if (unichar < 0x4000000)
112 /* check if unicode char has a valid numeric range */
113 static int utf8_unichar_valid_range(int unichar)
115 if (unichar > 0x10ffff)
117 if ((unichar & 0xfffff800) == 0xd800)
119 if ((unichar > 0xfdcf) && (unichar < 0xfdf0))
121 if ((unichar & 0xffff) == 0xffff)
126 /* validate one encoded unicode char and return its length */
127 int volume_id_utf8_encoded_valid_unichar(const char *str)
133 len = utf8_encoded_expected_len(str);
141 /* check if expected encoded chars are available */
142 for (i = 0; i < len; i++)
143 if ((str[i] & 0x80) != 0x80)
146 unichar = utf8_encoded_to_unichar(str);
148 /* check if encoded length matches encoded value */
149 if (utf8_unichar_to_encoded_len(unichar) != len)
152 /* check if value has valid range */
153 if (!utf8_unichar_valid_range(unichar))
159 size_t volume_id_set_unicode16(uint8_t *str, size_t len, const uint8_t *buf, enum endian endianess, size_t count)
165 for (i = 0; i + 2 <= count; i += 2) {
167 c = (buf[i+1] << 8) | buf[i];
169 c = (buf[i] << 8) | buf[i+1];
173 } else if (c < 0x80) {
176 str[j++] = (uint8_t) c;
177 } else if (c < 0x800) {
180 str[j++] = (uint8_t) (0xc0 | (c >> 6));
181 str[j++] = (uint8_t) (0x80 | (c & 0x3f));
185 str[j++] = (uint8_t) (0xe0 | (c >> 12));
186 str[j++] = (uint8_t) (0x80 | ((c >> 6) & 0x3f));
187 str[j++] = (uint8_t) (0x80 | (c & 0x3f));
194 static char *usage_to_string(enum volume_id_usage usage_id)
197 case VOLUME_ID_FILESYSTEM:
199 case VOLUME_ID_OTHER:
203 case VOLUME_ID_CRYPTO:
205 case VOLUME_ID_UNUSED:
211 void volume_id_set_usage(struct volume_id *id, enum volume_id_usage usage_id)
213 id->usage_id = usage_id;
214 id->usage = usage_to_string(usage_id);
217 void volume_id_set_label_raw(struct volume_id *id, const uint8_t *buf, size_t count)
219 if (count > sizeof(id->label_raw))
220 count = sizeof(id->label_raw);
222 memcpy(id->label_raw, buf, count);
223 id->label_raw_len = count;
226 void volume_id_set_label_string(struct volume_id *id, const uint8_t *buf, size_t count)
230 if (count >= sizeof(id->label))
231 count = sizeof(id->label)-1;
233 memcpy(id->label, buf, count);
234 id->label[count] = '\0';
236 /* remove trailing whitespace */
237 i = strnlen(id->label, count);
239 if (!isspace(id->label[i]))
242 id->label[i+1] = '\0';
245 void volume_id_set_label_unicode16(struct volume_id *id, const uint8_t *buf, enum endian endianess, size_t count)
247 if (count >= sizeof(id->label))
248 count = sizeof(id->label)-1;
250 volume_id_set_unicode16((uint8_t *)id->label, sizeof(id->label), buf, endianess, count);
253 static void set_uuid(const uint8_t *buf, size_t len, enum uuid_format format,
254 char *uuid, uint8_t *uuid_raw, size_t *uuid_raw_len)
257 unsigned int count = 0;
263 case UUID_HEX_STRING:
282 memcpy(uuid_raw, buf, count);
283 *uuid_raw_len = count;
285 /* if set, create string in the same format, the native platform uses */
286 for (i = 0; i < count; i++)
294 sprintf(uuid, "%02X%02X-%02X%02X",
295 buf[3], buf[2], buf[1], buf[0]);
298 sprintf(uuid,"%02X%02X%02X%02X%02X%02X%02X%02X",
299 buf[7], buf[6], buf[5], buf[4],
300 buf[3], buf[2], buf[1], buf[0]);
304 "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
305 buf[0], buf[1], buf[2], buf[3],
309 buf[10], buf[11], buf[12], buf[13], buf[14],buf[15]);
311 case UUID_HEX_STRING:
312 /* translate A..F to a..f */
313 memcpy(uuid, buf, count);
314 for (i = 0; i < count; i++)
315 if (uuid[i] >= 'A' && uuid[i] <= 'F')
316 uuid[i] = (uuid[i] - 'A') + 'a';
320 memcpy(uuid, buf, count);
325 "%02x%02x%02x%02x:%02x%02x%02x%02x:%02x%02x%02x%02x:%02x%02x%02x%02x",
326 buf[0], buf[1], buf[2], buf[3],
327 buf[4], buf[5], buf[6], buf[7],
328 buf[8], buf[9], buf[10], buf[11],
329 buf[12], buf[13], buf[14],buf[15]);
333 "%c%c%c%c%c%c-%c%c%c%c-%c%c%c%c-%c%c%c%c-%c%c%c%c-%c%c%c%c-%c%c%c%c%c%c",
334 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5],
335 buf[6], buf[7], buf[8], buf[9],
336 buf[10], buf[11], buf[12], buf[13],
337 buf[14], buf[15], buf[16], buf[17],
338 buf[18], buf[19], buf[20], buf[21],
339 buf[22], buf[23], buf[24], buf[25],
340 buf[26], buf[27], buf[28], buf[29], buf[30], buf[31]);
345 void volume_id_set_uuid(struct volume_id *id, const uint8_t *buf, size_t len, enum uuid_format format)
347 if (len > sizeof(id->uuid_raw))
348 len = sizeof(id->uuid_raw);
350 set_uuid(buf, len, format, id->uuid, id->uuid_raw, &id->uuid_raw_len);
353 void volume_id_set_uuid_sub(struct volume_id *id, const uint8_t *buf, size_t len, enum uuid_format format)
355 if (len > sizeof(id->uuid_sub_raw))
356 len = sizeof(id->uuid_sub_raw);
358 set_uuid(buf, len, format, id->uuid_sub, id->uuid_sub_raw, &id->uuid_sub_raw_len);
361 uint8_t *volume_id_get_buffer(struct volume_id *id, uint64_t off, size_t len)
365 info("get buffer off 0x%" PRIx64 "(%" PRIu64 "), len 0x%zx\n", off, off, len);
366 /* check if requested area fits in superblock buffer */
367 if (off + len <= SB_BUFFER_SIZE) {
368 if (id->sbbuf == NULL) {
369 id->sbbuf = malloc(SB_BUFFER_SIZE);
370 if (id->sbbuf == NULL) {
371 dbg("error malloc\n");
376 /* check if we need to read */
377 if ((off + len) > id->sbbuf_len) {
378 info("read sbbuf len:0x%" PRIx64 "\n", (off + len));
379 if (lseek(id->fd, 0, SEEK_SET) < 0) {
380 dbg("lseek failed (%s)\n", strerror(errno));
383 buf_len = read(id->fd, id->sbbuf, off + len);
385 dbg("read failed (%s)\n", strerror(errno));
388 dbg("got 0x%zx (%zi) bytes\n", buf_len, buf_len);
389 id->sbbuf_len = buf_len;
390 if ((size_t)buf_len < off + len) {
391 dbg("requested 0x%zx bytes, got only 0x%zx bytes\n", len, buf_len);
396 return &(id->sbbuf[off]);
398 if (len > SEEK_BUFFER_SIZE) {
399 dbg("seek buffer too small %d\n", SEEK_BUFFER_SIZE);
403 /* get seek buffer */
404 if (id->seekbuf == NULL) {
405 id->seekbuf = malloc(SEEK_BUFFER_SIZE);
406 if (id->seekbuf == NULL) {
407 dbg("error malloc\n");
412 /* check if we need to read */
413 if ((off < id->seekbuf_off) || ((off + len) > (id->seekbuf_off + id->seekbuf_len))) {
414 info("read seekbuf off:0x%" PRIx64 " len:0x%zx\n", off, len);
415 if (lseek(id->fd, off, SEEK_SET) < 0) {
416 dbg("lseek failed (%s)\n", strerror(errno));
419 buf_len = read(id->fd, id->seekbuf, len);
421 dbg("read failed (%s)\n", strerror(errno));
424 dbg("got 0x%zx (%zi) bytes\n", buf_len, buf_len);
425 id->seekbuf_off = off;
426 id->seekbuf_len = buf_len;
427 if ((size_t)buf_len < len) {
428 dbg("requested 0x%zx bytes, got only 0x%zx bytes\n", len, buf_len);
433 return &(id->seekbuf[off - id->seekbuf_off]);
437 void volume_id_free_buffer(struct volume_id *id)
439 if (id->sbbuf != NULL) {
444 if (id->seekbuf != NULL) {