1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2019 Namjae Jeon <linkinjeon@kernel.org>
9 #include <sys/sysmacros.h>
20 #include "exfat_ondisk.h"
24 #include "exfat_dir.h"
26 unsigned int print_level = EXFAT_INFO;
28 void exfat_bitmap_set_range(struct exfat *exfat, char *bitmap,
29 clus_t start_clus, clus_t count)
33 if (!exfat_heap_clus(exfat, start_clus) ||
34 !exfat_heap_clus(exfat, start_clus + count - 1))
38 while (clus < start_clus + count) {
39 exfat_bitmap_set(bitmap, clus);
44 static int exfat_bitmap_find_bit(struct exfat *exfat, char *bmap,
45 clus_t start_clu, clus_t *next,
50 last_clu = le32_to_cpu(exfat->bs->bsx.clu_count) +
52 while (start_clu < last_clu) {
53 if (!!exfat_bitmap_get(bmap, start_clu) == bit) {
62 int exfat_bitmap_find_zero(struct exfat *exfat, char *bmap,
63 clus_t start_clu, clus_t *next)
65 return exfat_bitmap_find_bit(exfat, bmap,
69 int exfat_bitmap_find_one(struct exfat *exfat, char *bmap,
70 clus_t start_clu, clus_t *next)
72 return exfat_bitmap_find_bit(exfat, bmap,
76 wchar_t exfat_bad_char(wchar_t w)
79 || (w == '*') || (w == '?') || (w == '<') || (w == '>')
80 || (w == '|') || (w == '"') || (w == ':') || (w == '/')
84 void boot_calc_checksum(unsigned char *sector, unsigned short size,
85 bool is_boot_sec, __le32 *checksum)
90 for (index = 0; index < size; index++) {
91 if ((index == 106) || (index == 107) || (index == 112))
93 *checksum = ((*checksum & 1) ? 0x80000000 : 0) +
94 (*checksum >> 1) + sector[index];
97 for (index = 0; index < size; index++) {
98 *checksum = ((*checksum & 1) ? 0x80000000 : 0) +
99 (*checksum >> 1) + sector[index];
104 void show_version(void)
106 printf("exfatprogs version : %s\n", EXFAT_PROGS_VERSION);
109 static inline unsigned int sector_size_bits(unsigned int size)
111 unsigned int bits = 8;
116 } while (size > 256);
121 static void exfat_set_default_cluster_size(struct exfat_blk_dev *bd,
122 struct exfat_user_input *ui)
124 if (256 * MB >= bd->size)
125 ui->cluster_size = 4 * KB;
126 else if (32 * GB >= bd->size)
127 ui->cluster_size = 32 * KB;
129 ui->cluster_size = 128 * KB;
132 void init_user_input(struct exfat_user_input *ui)
134 memset(ui, 0, sizeof(struct exfat_user_input));
135 ui->writeable = true;
139 int exfat_get_blk_dev_info(struct exfat_user_input *ui,
140 struct exfat_blk_dev *bd)
145 unsigned long long blk_dev_offset = 0;
147 fd = open(ui->dev_name, ui->writeable ? O_RDWR|O_EXCL : O_RDONLY);
149 exfat_err("open failed : %s, %s\n", ui->dev_name,
153 blk_dev_size = lseek(fd, 0, SEEK_END);
154 if (blk_dev_size <= 0) {
155 exfat_err("invalid block device size(%s)\n",
162 if (fstat(fd, &st) == 0 && S_ISBLK(st.st_mode)) {
163 char pathname[sizeof("/sys/dev/block/4294967295:4294967295/start")];
166 snprintf(pathname, sizeof(pathname), "/sys/dev/block/%u:%u/start",
167 major(st.st_rdev), minor(st.st_rdev));
168 fp = fopen(pathname, "r");
170 if (fscanf(fp, "%llu", &blk_dev_offset) == 1) {
172 * Linux kernel always reports partition offset
173 * in 512-byte units, regardless of sector size
175 blk_dev_offset <<= 9;
182 bd->offset = blk_dev_offset;
183 bd->size = blk_dev_size;
184 if (!ui->cluster_size)
185 exfat_set_default_cluster_size(bd, ui);
187 if (!ui->boundary_align)
188 ui->boundary_align = DEFAULT_BOUNDARY_ALIGNMENT;
190 if (ioctl(fd, BLKSSZGET, &bd->sector_size) < 0)
191 bd->sector_size = DEFAULT_SECTOR_SIZE;
192 bd->sector_size_bits = sector_size_bits(bd->sector_size);
193 bd->num_sectors = blk_dev_size / bd->sector_size;
194 bd->num_clusters = blk_dev_size / ui->cluster_size;
196 exfat_debug("Block device name : %s\n", ui->dev_name);
197 exfat_debug("Block device offset : %llu\n", bd->offset);
198 exfat_debug("Block device size : %llu\n", bd->size);
199 exfat_debug("Block sector size : %u\n", bd->sector_size);
200 exfat_debug("Number of the sectors : %llu\n",
202 exfat_debug("Number of the clusters : %u\n",
211 ssize_t exfat_read(int fd, void *buf, size_t size, off_t offset)
213 return pread(fd, buf, size, offset);
216 ssize_t exfat_write(int fd, void *buf, size_t size, off_t offset)
218 return pwrite(fd, buf, size, offset);
221 size_t exfat_utf16_len(const __le16 *str, size_t max_size)
225 while (le16_to_cpu(str[i]) && i < max_size)
230 ssize_t exfat_utf16_enc(const char *in_str, __u16 *out_str, size_t out_size)
232 size_t mbs_len, out_len, i;
235 mbs_len = mbstowcs(NULL, in_str, 0);
236 if (mbs_len == (size_t)-1) {
237 if (errno == EINVAL || errno == EILSEQ)
238 exfat_err("invalid character sequence in current locale\n");
242 wcs = calloc(mbs_len+1, sizeof(wchar_t));
246 /* First convert multibyte char* string to wchar_t* string */
247 if (mbstowcs(wcs, in_str, mbs_len+1) == (size_t)-1) {
248 if (errno == EINVAL || errno == EILSEQ)
249 exfat_err("invalid character sequence in current locale\n");
254 /* Convert wchar_t* string (sequence of code points) to UTF-16 string */
255 for (i = 0, out_len = 0; i < mbs_len; i++) {
256 if (2*(out_len+1) > out_size ||
257 (wcs[i] >= 0x10000 && 2*(out_len+2) > out_size)) {
258 exfat_err("input string is too long\n");
263 /* Encode code point above Plane0 as UTF-16 surrogate pair */
264 if (wcs[i] >= 0x10000) {
266 cpu_to_le16(((wcs[i] - 0x10000) >> 10) + 0xD800);
267 wcs[i] = ((wcs[i] - 0x10000) & 0x3FF) + 0xDC00;
270 out_str[out_len++] = cpu_to_le16(wcs[i]);
277 ssize_t exfat_utf16_dec(const __u16 *in_str, size_t in_len,
278 char *out_str, size_t out_size)
280 size_t wcs_len, out_len, c_len, i;
281 char c_str[MB_LEN_MAX];
286 wcs = calloc(in_len/2+1, sizeof(wchar_t));
290 /* First convert UTF-16 string to wchar_t* string */
291 for (i = 0, wcs_len = 0; i < in_len/2; i++, wcs_len++) {
292 wcs[wcs_len] = le16_to_cpu(in_str[i]);
294 * If wchar_t can store code point above Plane0
295 * then unpack UTF-16 surrogate pair to code point
297 #if WCHAR_MAX >= 0x10FFFF
298 if (wcs[wcs_len] >= 0xD800 && wcs[wcs_len] <= 0xDBFF &&
300 w = le16_to_cpu(in_str[i+1]);
301 if (w >= 0xDC00 && w <= 0xDFFF) {
302 wcs[wcs_len] = 0x10000 +
303 ((wcs[wcs_len] - 0xD800) << 10) +
311 memset(&ps, 0, sizeof(ps));
313 /* And then convert wchar_t* string to multibyte char* string */
314 for (i = 0, out_len = 0, c_len = 0; i <= wcs_len; i++) {
315 c_len = wcrtomb(c_str, wcs[i], &ps);
317 * If character is non-representable in current locale then
318 * try to store it as Unicode replacement code point U+FFFD
320 if (c_len == (size_t)-1 && errno == EILSEQ)
321 c_len = wcrtomb(c_str, 0xFFFD, &ps);
322 /* If U+FFFD is also non-representable, try question mark */
323 if (c_len == (size_t)-1 && errno == EILSEQ)
324 c_len = wcrtomb(c_str, L'?', &ps);
325 /* If also (7bit) question mark fails then we cannot do more */
326 if (c_len == (size_t)-1) {
327 exfat_err("invalid UTF-16 sequence\n");
331 if (out_len+c_len > out_size) {
332 exfat_err("input string is too long\n");
336 memcpy(out_str+out_len, c_str, c_len);
342 /* Last iteration of above loop should have produced null byte */
343 if (c_len == 0 || out_str[out_len-1] != 0) {
344 exfat_err("invalid UTF-16 sequence\n");
351 off_t exfat_get_root_entry_offset(struct exfat_blk_dev *bd)
355 unsigned int cluster_size, sector_size;
358 bs = (struct pbr *)malloc(EXFAT_MAX_SECTOR_SIZE);
360 exfat_err("failed to allocate memory\n");
364 nbytes = exfat_read(bd->dev_fd, bs, EXFAT_MAX_SECTOR_SIZE, 0);
365 if (nbytes != EXFAT_MAX_SECTOR_SIZE) {
366 exfat_err("boot sector read failed: %d\n", errno);
371 if (memcmp(bs->bpb.oem_name, "EXFAT ", 8) != 0) {
372 exfat_err("Bad fs_name in boot sector, which does not describe a valid exfat filesystem\n");
377 sector_size = 1 << bs->bsx.sect_size_bits;
378 cluster_size = (1 << bs->bsx.sect_per_clus_bits) * sector_size;
379 root_clu_off = le32_to_cpu(bs->bsx.clu_offset) * sector_size +
380 (le32_to_cpu(bs->bsx.root_cluster) - EXFAT_RESERVED_CLUSTERS) *
387 char *exfat_conv_volume_label(struct exfat_dentry *vol_entry)
390 __le16 disk_label[VOLUME_LABEL_MAX_LEN];
392 volume_label = malloc(VOLUME_LABEL_BUFFER_SIZE);
396 memcpy(disk_label, vol_entry->vol_label, sizeof(disk_label));
397 memset(volume_label, 0, VOLUME_LABEL_BUFFER_SIZE);
398 if (exfat_utf16_dec(disk_label, vol_entry->vol_char_cnt*2,
399 volume_label, VOLUME_LABEL_BUFFER_SIZE) < 0) {
400 exfat_err("failed to decode volume label\n");
408 int exfat_read_volume_label(struct exfat *exfat)
410 struct exfat_dentry *dentry;
412 __le16 disk_label[VOLUME_LABEL_MAX_LEN];
413 struct exfat_lookup_filter filter = {
414 .in.type = EXFAT_VOLUME,
418 err = exfat_lookup_dentry_set(exfat, exfat->root, &filter);
422 dentry = filter.out.dentry_set;
424 if (dentry->vol_char_cnt == 0)
427 if (dentry->vol_char_cnt > VOLUME_LABEL_MAX_LEN) {
428 exfat_err("too long label. %d\n", dentry->vol_char_cnt);
433 memcpy(disk_label, dentry->vol_label, sizeof(disk_label));
434 if (exfat_utf16_dec(disk_label, dentry->vol_char_cnt*2,
435 exfat->volume_label, sizeof(exfat->volume_label)) < 0) {
436 exfat_err("failed to decode volume label\n");
441 exfat_info("label: %s\n", exfat->volume_label);
443 free(filter.out.dentry_set);
447 int exfat_set_volume_label(struct exfat *exfat, char *label_input)
449 struct exfat_dentry *pvol;
450 struct exfat_dentry_loc loc;
451 __u16 volume_label[VOLUME_LABEL_MAX_LEN];
452 int volume_label_len, dcount, err;
454 struct exfat_lookup_filter filter = {
455 .in.type = EXFAT_VOLUME,
459 err = exfat_lookup_dentry_set(exfat, exfat->root, &filter);
461 pvol = filter.out.dentry_set;
462 dcount = filter.out.dentry_count;
463 memset(pvol->vol_label, 0, sizeof(pvol->vol_label));
465 pvol = calloc(sizeof(struct exfat_dentry), 1);
470 pvol->type = EXFAT_VOLUME;
473 volume_label_len = exfat_utf16_enc(label_input,
474 volume_label, sizeof(volume_label));
475 if (volume_label_len < 0) {
476 exfat_err("failed to encode volume label\n");
481 memcpy(pvol->vol_label, volume_label, volume_label_len);
482 pvol->vol_char_cnt = volume_label_len/2;
484 loc.parent = exfat->root;
485 loc.file_offset = filter.out.file_offset;
486 loc.dev_offset = filter.out.dev_offset;
487 err = exfat_add_dentry_set(exfat, &loc, pvol, dcount, false);
488 exfat_info("new label: %s\n", label_input);
495 int exfat_read_sector(struct exfat_blk_dev *bd, void *buf, unsigned int sec_off)
498 unsigned long long offset =
499 (unsigned long long)sec_off * bd->sector_size;
501 ret = pread(bd->dev_fd, buf, bd->sector_size, offset);
503 exfat_err("read failed, sec_off : %u\n", sec_off);
509 int exfat_write_sector(struct exfat_blk_dev *bd, void *buf,
510 unsigned int sec_off)
513 unsigned long long offset =
514 (unsigned long long)sec_off * bd->sector_size;
516 bytes = pwrite(bd->dev_fd, buf, bd->sector_size, offset);
517 if (bytes != (int)bd->sector_size) {
518 exfat_err("write failed, sec_off : %u, bytes : %d\n", sec_off,
525 int exfat_write_checksum_sector(struct exfat_blk_dev *bd,
526 unsigned int checksum, bool is_backup)
528 __le32 *checksum_buf;
531 unsigned int sec_idx = CHECKSUM_SEC_IDX;
533 checksum_buf = malloc(bd->sector_size);
538 sec_idx += BACKUP_BOOT_SEC_IDX;
540 for (i = 0; i < bd->sector_size / sizeof(int); i++)
541 checksum_buf[i] = cpu_to_le32(checksum);
543 ret = exfat_write_sector(bd, checksum_buf, sec_idx);
545 exfat_err("checksum sector write failed\n");
554 int exfat_show_volume_serial(int fd)
559 ppbr = malloc(EXFAT_MAX_SECTOR_SIZE);
561 exfat_err("Cannot allocate pbr: out of memory\n");
565 /* read main boot sector */
566 ret = exfat_read(fd, (char *)ppbr, EXFAT_MAX_SECTOR_SIZE, 0);
568 exfat_err("main boot sector read failed\n");
573 if (memcmp(ppbr->bpb.oem_name, "EXFAT ", 8) != 0) {
574 exfat_err("Bad fs_name in boot sector, which does not describe a valid exfat filesystem\n");
579 exfat_info("volume serial : 0x%x\n", ppbr->bsx.vol_serial);
586 static int exfat_update_boot_checksum(struct exfat_blk_dev *bd, bool is_backup)
588 unsigned int checksum = 0;
589 int ret, sec_idx, backup_sec_idx = 0;
592 buf = malloc(bd->sector_size);
594 exfat_err("Cannot allocate pbr: out of memory\n");
599 backup_sec_idx = BACKUP_BOOT_SEC_IDX;
601 for (sec_idx = BOOT_SEC_IDX; sec_idx < CHECKSUM_SEC_IDX; sec_idx++) {
602 bool is_boot_sec = false;
604 ret = exfat_read_sector(bd, buf, sec_idx + backup_sec_idx);
606 exfat_err("sector(%d) read failed\n", sec_idx);
611 if (sec_idx == BOOT_SEC_IDX)
614 boot_calc_checksum(buf, bd->sector_size, is_boot_sec,
618 ret = exfat_write_checksum_sector(bd, checksum, is_backup);
626 int exfat_set_volume_serial(struct exfat_blk_dev *bd,
627 struct exfat_user_input *ui)
632 ppbr = malloc(EXFAT_MAX_SECTOR_SIZE);
634 exfat_err("Cannot allocate pbr: out of memory\n");
638 /* read main boot sector */
639 ret = exfat_read(bd->dev_fd, (char *)ppbr, EXFAT_MAX_SECTOR_SIZE,
642 exfat_err("main boot sector read failed\n");
647 if (memcmp(ppbr->bpb.oem_name, "EXFAT ", 8) != 0) {
648 exfat_err("Bad fs_name in boot sector, which does not describe a valid exfat filesystem\n");
653 bd->sector_size = 1 << ppbr->bsx.sect_size_bits;
654 ppbr->bsx.vol_serial = ui->volume_serial;
656 /* update main boot sector */
657 ret = exfat_write_sector(bd, (char *)ppbr, BOOT_SEC_IDX);
659 exfat_err("main boot sector write failed\n");
664 /* update backup boot sector */
665 ret = exfat_write_sector(bd, (char *)ppbr, BACKUP_BOOT_SEC_IDX);
667 exfat_err("backup boot sector write failed\n");
672 ret = exfat_update_boot_checksum(bd, 0);
674 exfat_err("main checksum update failed\n");
678 ret = exfat_update_boot_checksum(bd, 1);
680 exfat_err("backup checksum update failed\n");
684 exfat_info("New volume serial : 0x%x\n", ui->volume_serial);
689 unsigned int exfat_clus_to_blk_dev_off(struct exfat_blk_dev *bd,
690 unsigned int clu_off_sectnr, unsigned int clu)
692 return clu_off_sectnr * bd->sector_size +
693 (clu - EXFAT_RESERVED_CLUSTERS) * bd->cluster_size;
696 int exfat_get_next_clus(struct exfat *exfat, clus_t clus, clus_t *next)
700 *next = EXFAT_EOF_CLUSTER;
702 if (!exfat_heap_clus(exfat, clus))
705 offset = (off_t)le32_to_cpu(exfat->bs->bsx.fat_offset) <<
706 exfat->bs->bsx.sect_size_bits;
707 offset += sizeof(clus_t) * clus;
709 if (exfat_read(exfat->blk_dev->dev_fd, next, sizeof(*next), offset)
712 *next = le32_to_cpu(*next);
716 int exfat_get_inode_next_clus(struct exfat *exfat, struct exfat_inode *node,
717 clus_t clus, clus_t *next)
719 *next = EXFAT_EOF_CLUSTER;
721 if (node->is_contiguous) {
722 if (!exfat_heap_clus(exfat, clus))
728 return exfat_get_next_clus(exfat, clus, next);
731 int exfat_set_fat(struct exfat *exfat, clus_t clus, clus_t next_clus)
735 offset = le32_to_cpu(exfat->bs->bsx.fat_offset) <<
736 exfat->bs->bsx.sect_size_bits;
737 offset += sizeof(clus_t) * clus;
739 if (exfat_write(exfat->blk_dev->dev_fd, &next_clus, sizeof(next_clus),
740 offset) != sizeof(next_clus))
745 off_t exfat_s2o(struct exfat *exfat, off_t sect)
747 return sect << exfat->bs->bsx.sect_size_bits;
750 off_t exfat_c2o(struct exfat *exfat, unsigned int clus)
752 assert(clus >= EXFAT_FIRST_CLUSTER);
754 return exfat_s2o(exfat, le32_to_cpu(exfat->bs->bsx.clu_offset) +
755 ((off_t)(clus - EXFAT_FIRST_CLUSTER) <<
756 exfat->bs->bsx.sect_per_clus_bits));
759 int exfat_o2c(struct exfat *exfat, off_t device_offset,
760 unsigned int *clu, unsigned int *offset)
764 heap_offset = exfat_s2o(exfat, le32_to_cpu(exfat->bs->bsx.clu_offset));
765 if (device_offset < heap_offset)
768 *clu = (unsigned int)((device_offset - heap_offset) /
769 exfat->clus_size) + EXFAT_FIRST_CLUSTER;
770 if (!exfat_heap_clus(exfat, *clu))
772 *offset = (device_offset - heap_offset) % exfat->clus_size;
776 bool exfat_heap_clus(struct exfat *exfat, clus_t clus)
778 return clus >= EXFAT_FIRST_CLUSTER &&
779 (clus - EXFAT_FIRST_CLUSTER) < exfat->clus_count;
782 int exfat_root_clus_count(struct exfat *exfat)
784 struct exfat_inode *node = exfat->root;
788 if (!exfat_heap_clus(exfat, node->first_clus))
791 clus = node->first_clus;
793 if (exfat_bitmap_get(exfat->alloc_bitmap, clus))
796 exfat_bitmap_set(exfat->alloc_bitmap, clus);
798 if (exfat_get_inode_next_clus(exfat, node, clus, &next)) {
799 exfat_err("ERROR: failed to read the fat entry of root");
803 if (next != EXFAT_EOF_CLUSTER && !exfat_heap_clus(exfat, next))
808 } while (clus != EXFAT_EOF_CLUSTER);
810 node->size = clus_count * exfat->clus_size;
814 int read_boot_sect(struct exfat_blk_dev *bdev, struct pbr **bs)
818 unsigned int sect_size, clu_size;
820 pbr = malloc(sizeof(struct pbr));
822 if (exfat_read(bdev->dev_fd, pbr, sizeof(*pbr), 0) !=
823 (ssize_t)sizeof(*pbr)) {
824 exfat_err("failed to read a boot sector\n");
830 if (memcmp(pbr->bpb.oem_name, "EXFAT ", 8) != 0) {
831 exfat_err("failed to find exfat file system\n");
835 sect_size = 1 << pbr->bsx.sect_size_bits;
836 clu_size = 1 << (pbr->bsx.sect_size_bits +
837 pbr->bsx.sect_per_clus_bits);
839 if (sect_size < 512 || sect_size > 4 * KB) {
840 exfat_err("too small or big sector size: %d\n",
845 if (clu_size < sect_size || clu_size > 32 * MB) {
846 exfat_err("too small or big cluster size: %d\n",