/*
- * cluster.c
- * exFAT file system implementation library.
- *
- * Created by Andrew Nayenko on 03.09.09.
- * This software is distributed under the GNU General Public License
- * version 3 or any later.
- */
+ cluster.c (03.09.09)
+ exFAT file system implementation library.
+
+ Free exFAT implementation.
+ Copyright (C) 2010-2016 Andrew Nayenko
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
#include "exfat.h"
#include <errno.h>
#include <string.h>
+#include <inttypes.h>
-#define BMAP_GET(bitmap, index) ((bitmap)[(index) / 8] & (1u << ((index) % 8)))
-#define BMAP_SET(bitmap, index) (bitmap)[(index) / 8] |= (1u << ((index) % 8))
-#define BMAP_CLR(bitmap, index) (bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
+/*
+ * Sector to absolute offset.
+ */
+static off_t s2o(const struct exfat* ef, off_t sector)
+{
+ return sector << ef->sb->sector_bits;
+}
/*
- * Cluster to block.
+ * Cluster to sector.
*/
-static uint32_t c2b(const struct exfat* ef, cluster_t cluster)
+static off_t c2s(const struct exfat* ef, cluster_t cluster)
{
if (cluster < EXFAT_FIRST_DATA_CLUSTER)
exfat_bug("invalid cluster number %u", cluster);
- return le32_to_cpu(ef->sb->cluster_block_start) +
- ((cluster - EXFAT_FIRST_DATA_CLUSTER) << ef->sb->bpc_bits);
+ return le32_to_cpu(ef->sb->cluster_sector_start) +
+ ((off_t) (cluster - EXFAT_FIRST_DATA_CLUSTER) << ef->sb->spc_bits);
}
/*
*/
off_t exfat_c2o(const struct exfat* ef, cluster_t cluster)
{
- return (off_t) c2b(ef, cluster) << ef->sb->block_bits;
+ return s2o(ef, c2s(ef, cluster));
}
/*
- * Block to absolute offset.
+ * Sector to cluster.
*/
-static off_t b2o(const struct exfat* ef, uint32_t block)
+static cluster_t s2c(const struct exfat* ef, off_t sector)
{
- return (off_t) block << ef->sb->block_bits;
+ return ((sector - le32_to_cpu(ef->sb->cluster_sector_start)) >>
+ ef->sb->spc_bits) + EXFAT_FIRST_DATA_CLUSTER;
}
/*
cluster_t exfat_next_cluster(const struct exfat* ef,
const struct exfat_node* node, cluster_t cluster)
{
- cluster_t next;
+ le32_t next;
off_t fat_offset;
if (cluster < EXFAT_FIRST_DATA_CLUSTER)
if (IS_CONTIGUOUS(*node))
return cluster + 1;
- fat_offset = b2o(ef, le32_to_cpu(ef->sb->fat_block_start))
+ fat_offset = s2o(ef, le32_to_cpu(ef->sb->fat_sector_start))
+ cluster * sizeof(cluster_t);
- exfat_read_raw(&next, sizeof(next), fat_offset, ef->fd);
- return next;
+ if (exfat_pread(ef->dev, &next, sizeof(next), fat_offset) < 0)
+ return EXFAT_CLUSTER_BAD; /* the caller should handle this and print
+ appropriate error message */
+ return le32_to_cpu(next);
}
cluster_t exfat_advance_cluster(const struct exfat* ef,
{
node->fptr_cluster = exfat_next_cluster(ef, node, node->fptr_cluster);
if (CLUSTER_INVALID(node->fptr_cluster))
- break;
+ break; /* the caller should handle this and print appropriate
+ error message */
}
node->fptr_index = count;
return node->fptr_cluster;
}
-static cluster_t find_bit_and_set(uint8_t* bitmap, cluster_t start,
- cluster_t end)
+static cluster_t find_bit_and_set(bitmap_t* bitmap, size_t start, size_t end)
{
- const cluster_t mid_start = (start + 7) / 8 * 8;
- const cluster_t mid_end = end / 8 * 8;
- cluster_t c;
- cluster_t byte;
-
- for (c = start; c < mid_start; c++)
- if (BMAP_GET(bitmap, c) == 0)
- {
- BMAP_SET(bitmap, c);
- return c + EXFAT_FIRST_DATA_CLUSTER;
- }
+ const size_t start_index = start / sizeof(bitmap_t) / 8;
+ const size_t end_index = DIV_ROUND_UP(end, sizeof(bitmap_t) * 8);
+ size_t i;
+ size_t start_bitindex;
+ size_t end_bitindex;
+ size_t c;
+
+ for (i = start_index; i < end_index; i++)
+ {
+ if (bitmap[i] == ~((bitmap_t) 0))
+ continue;
+ start_bitindex = MAX(i * sizeof(bitmap_t) * 8, start);
+ end_bitindex = MIN((i + 1) * sizeof(bitmap_t) * 8, end);
+ for (c = start_bitindex; c < end_bitindex; c++)
+ if (BMAP_GET(bitmap, c) == 0)
+ {
+ BMAP_SET(bitmap, c);
+ return c + EXFAT_FIRST_DATA_CLUSTER;
+ }
+ }
+ return EXFAT_CLUSTER_END;
+}
- for (byte = mid_start / 8; byte < mid_end / 8; byte++)
- if (bitmap[byte] != 0xff)
- {
- cluster_t bit;
-
- for (bit = 0; bit < 8; bit++)
- if (!(bitmap[byte] & (1u << bit)))
- {
- bitmap[byte] |= (1u << bit);
- return byte * 8 + bit + EXFAT_FIRST_DATA_CLUSTER;
- }
- }
+static int flush_nodes(struct exfat* ef, struct exfat_node* node)
+{
+ struct exfat_node* p;
- for (c = mid_end; c < end; c++)
- if (BMAP_GET(bitmap, c) == 0)
- {
- BMAP_SET(bitmap, c);
- return c + EXFAT_FIRST_DATA_CLUSTER;
- }
+ for (p = node->child; p != NULL; p = p->next)
+ {
+ int rc = flush_nodes(ef, p);
+ if (rc != 0)
+ return rc;
+ }
+ return exfat_flush_node(ef, node);
+}
- return EXFAT_CLUSTER_END;
+int exfat_flush_nodes(struct exfat* ef)
+{
+ return flush_nodes(ef, ef->root);
}
-void exfat_flush_cmap(struct exfat* ef)
+int exfat_flush(struct exfat* ef)
{
- exfat_write_raw(ef->cmap.chunk, (ef->cmap.chunk_size + 7) / 8,
- exfat_c2o(ef, ef->cmap.start_cluster), ef->fd);
- ef->cmap.dirty = 0;
+ if (ef->cmap.dirty)
+ {
+ if (exfat_pwrite(ef->dev, ef->cmap.chunk,
+ BMAP_SIZE(ef->cmap.chunk_size),
+ exfat_c2o(ef, ef->cmap.start_cluster)) < 0)
+ {
+ exfat_error("failed to write clusters bitmap");
+ return -EIO;
+ }
+ ef->cmap.dirty = false;
+ }
+
+ return 0;
}
-static void set_next_cluster(const struct exfat* ef, int contiguous,
+static bool set_next_cluster(const struct exfat* ef, bool contiguous,
cluster_t current, cluster_t next)
{
off_t fat_offset;
+ le32_t next_le32;
if (contiguous)
- return;
- fat_offset = b2o(ef, le32_to_cpu(ef->sb->fat_block_start))
+ return true;
+ fat_offset = s2o(ef, le32_to_cpu(ef->sb->fat_sector_start))
+ current * sizeof(cluster_t);
- exfat_write_raw(&next, sizeof(next), fat_offset, ef->fd);
-}
-
-static void erase_cluster(struct exfat* ef, cluster_t cluster)
-{
- const int block_size = BLOCK_SIZE(*ef->sb);
- const int blocks_in_cluster = CLUSTER_SIZE(*ef->sb) / block_size;
- int i;
-
- for (i = 0; i < blocks_in_cluster; i++)
- exfat_write_raw(ef->zero_block, block_size,
- exfat_c2o(ef, cluster) + i * block_size, ef->fd);
+ next_le32 = cpu_to_le32(next);
+ if (exfat_pwrite(ef->dev, &next_le32, sizeof(next_le32), fat_offset) < 0)
+ {
+ exfat_error("failed to write the next cluster %#x after %#x", next,
+ current);
+ return false;
+ }
+ return true;
}
static cluster_t allocate_cluster(struct exfat* ef, cluster_t hint)
return EXFAT_CLUSTER_END;
}
- erase_cluster(ef, cluster);
- ef->cmap.dirty = 1;
- /* FIXME update percentage of used space */
+ ef->cmap.dirty = true;
return cluster;
}
static void free_cluster(struct exfat* ef, cluster_t cluster)
{
if (CLUSTER_INVALID(cluster))
- exfat_bug("attempting to free invalid cluster");
- if (cluster < EXFAT_FIRST_DATA_CLUSTER ||
- cluster - EXFAT_FIRST_DATA_CLUSTER >= ef->cmap.size)
- exfat_bug("bad cluster 0x%x (0x%x)", cluster, ef->cmap.size);
+ exfat_bug("freeing invalid cluster 0x%x", cluster);
+ if (cluster - EXFAT_FIRST_DATA_CLUSTER >= ef->cmap.size)
+ exfat_bug("freeing non-existing cluster 0x%x (0x%x)", cluster,
+ ef->cmap.size);
BMAP_CLR(ef->cmap.chunk, cluster - EXFAT_FIRST_DATA_CLUSTER);
- ef->cmap.dirty = 1;
- /* FIXME update percentage of used space */
+ ef->cmap.dirty = true;
}
-static void make_noncontiguous(const struct exfat* ef, cluster_t first,
+static bool make_noncontiguous(const struct exfat* ef, cluster_t first,
cluster_t last)
{
cluster_t c;
for (c = first; c < last; c++)
- set_next_cluster(ef, 0, c, c + 1);
+ if (!set_next_cluster(ef, false, c, c + 1))
+ return false;
+ return true;
}
+static int shrink_file(struct exfat* ef, struct exfat_node* node,
+ uint32_t current, uint32_t difference);
+
static int grow_file(struct exfat* ef, struct exfat_node* node,
- uint32_t difference)
+ uint32_t current, uint32_t difference)
{
cluster_t previous;
cluster_t next;
+ uint32_t allocated = 0;
if (difference == 0)
exfat_bug("zero clusters count passed");
if (node->start_cluster != EXFAT_CLUSTER_FREE)
{
/* get the last cluster of the file */
- previous = exfat_advance_cluster(ef, node,
- bytes2clusters(ef, node->size) - 1);
+ previous = exfat_advance_cluster(ef, node, current - 1);
if (CLUSTER_INVALID(previous))
{
- exfat_error("invalid cluster in file");
+ exfat_error("invalid cluster 0x%x while growing", previous);
return -EIO;
}
}
if (CLUSTER_INVALID(previous))
return -ENOSPC;
node->fptr_cluster = node->start_cluster = previous;
- difference--;
+ allocated = 1;
/* file consists of only one cluster, so it's contiguous */
node->flags |= EXFAT_ATTRIB_CONTIGUOUS;
}
- while (difference--)
+ while (allocated < difference)
{
next = allocate_cluster(ef, previous + 1);
if (CLUSTER_INVALID(next))
+ {
+ if (allocated != 0)
+ shrink_file(ef, node, current + allocated, allocated);
return -ENOSPC;
+ }
if (next != previous - 1 && IS_CONTIGUOUS(*node))
{
/* it's a pity, but we are not able to keep the file contiguous
anymore */
- make_noncontiguous(ef, node->start_cluster, previous);
+ if (!make_noncontiguous(ef, node->start_cluster, previous))
+ return -EIO;
node->flags &= ~EXFAT_ATTRIB_CONTIGUOUS;
+ node->flags |= EXFAT_ATTRIB_DIRTY;
}
- set_next_cluster(ef, IS_CONTIGUOUS(*node), previous, next);
+ if (!set_next_cluster(ef, IS_CONTIGUOUS(*node), previous, next))
+ return -EIO;
previous = next;
+ allocated++;
}
- set_next_cluster(ef, IS_CONTIGUOUS(*node), previous, EXFAT_CLUSTER_END);
+ if (!set_next_cluster(ef, IS_CONTIGUOUS(*node), previous,
+ EXFAT_CLUSTER_END))
+ return -EIO;
return 0;
}
static int shrink_file(struct exfat* ef, struct exfat_node* node,
- uint32_t difference)
+ uint32_t current, uint32_t difference)
{
- uint32_t current = bytes2clusters(ef, node->size);
cluster_t previous;
cluster_t next;
current - difference - 1);
if (CLUSTER_INVALID(last))
{
- exfat_error("invalid cluster in file");
+ exfat_error("invalid cluster 0x%x while shrinking", last);
return -EIO;
}
previous = exfat_next_cluster(ef, node, last);
- set_next_cluster(ef, IS_CONTIGUOUS(*node), last, EXFAT_CLUSTER_END);
+ if (!set_next_cluster(ef, IS_CONTIGUOUS(*node), last,
+ EXFAT_CLUSTER_END))
+ return -EIO;
}
else
{
previous = node->start_cluster;
node->start_cluster = EXFAT_CLUSTER_FREE;
+ node->flags |= EXFAT_ATTRIB_DIRTY;
}
node->fptr_index = 0;
node->fptr_cluster = node->start_cluster;
{
if (CLUSTER_INVALID(previous))
{
- exfat_error("invalid cluster in file");
+ exfat_error("invalid cluster 0x%x while freeing after shrink",
+ previous);
return -EIO;
}
next = exfat_next_cluster(ef, node, previous);
- set_next_cluster(ef, IS_CONTIGUOUS(*node), previous,
- EXFAT_CLUSTER_FREE);
+ if (!set_next_cluster(ef, IS_CONTIGUOUS(*node), previous,
+ EXFAT_CLUSTER_FREE))
+ return -EIO;
free_cluster(ef, previous);
previous = next;
}
return 0;
}
-int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size)
+static bool erase_raw(struct exfat* ef, size_t size, off_t offset)
+{
+ if (exfat_pwrite(ef->dev, ef->zero_cluster, size, offset) < 0)
+ {
+ exfat_error("failed to erase %zu bytes at %"PRId64, size, offset);
+ return false;
+ }
+ return true;
+}
+
+static int erase_range(struct exfat* ef, struct exfat_node* node,
+ uint64_t begin, uint64_t end)
+{
+ uint64_t cluster_boundary;
+ cluster_t cluster;
+
+ if (begin >= end)
+ return 0;
+
+ cluster_boundary = (begin | (CLUSTER_SIZE(*ef->sb) - 1)) + 1;
+ cluster = exfat_advance_cluster(ef, node,
+ begin / CLUSTER_SIZE(*ef->sb));
+ if (CLUSTER_INVALID(cluster))
+ {
+ exfat_error("invalid cluster 0x%x while erasing", cluster);
+ return -EIO;
+ }
+ /* erase from the beginning to the closest cluster boundary */
+ if (!erase_raw(ef, MIN(cluster_boundary, end) - begin,
+ exfat_c2o(ef, cluster) + begin % CLUSTER_SIZE(*ef->sb)))
+ return -EIO;
+ /* erase whole clusters */
+ while (cluster_boundary < end)
+ {
+ cluster = exfat_next_cluster(ef, node, cluster);
+ /* the cluster cannot be invalid because we have just allocated it */
+ if (CLUSTER_INVALID(cluster))
+ exfat_bug("invalid cluster 0x%x after allocation", cluster);
+ if (!erase_raw(ef, CLUSTER_SIZE(*ef->sb), exfat_c2o(ef, cluster)))
+ return -EIO;
+ cluster_boundary += CLUSTER_SIZE(*ef->sb);
+ }
+ return 0;
+}
+
+int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
+ bool erase)
{
uint32_t c1 = bytes2clusters(ef, node->size);
uint32_t c2 = bytes2clusters(ef, size);
int rc = 0;
+ if (node->references == 0 && node->parent)
+ exfat_bug("no references, node changes can be lost");
+
+ if (node->size == size)
+ return 0;
+
if (c1 < c2)
- rc = grow_file(ef, node, c2 - c1);
+ rc = grow_file(ef, node, c1, c2 - c1);
else if (c1 > c2)
- rc = shrink_file(ef, node, c1 - c2);
+ rc = shrink_file(ef, node, c1, c1 - c2);
if (rc != 0)
return rc;
- if (node->size != size)
+ if (erase)
{
- exfat_update_mtime(node);
- node->size = size;
- node->flags |= EXFAT_ATTRIB_DIRTY;
+ rc = erase_range(ef, node, node->size, size);
+ if (rc != 0)
+ return rc;
+ }
+
+ exfat_update_mtime(node);
+ node->size = size;
+ node->flags |= EXFAT_ATTRIB_DIRTY;
+ return 0;
+}
+
+uint32_t exfat_count_free_clusters(const struct exfat* ef)
+{
+ uint32_t free_clusters = 0;
+ uint32_t i;
+
+ for (i = 0; i < ef->cmap.size; i++)
+ if (BMAP_GET(ef->cmap.chunk, i) == 0)
+ free_clusters++;
+ return free_clusters;
+}
+
+static int find_used_clusters(const struct exfat* ef,
+ cluster_t* a, cluster_t* b)
+{
+ const cluster_t end = le32_to_cpu(ef->sb->cluster_count);
+
+ /* find first used cluster */
+ for (*a = *b + 1; *a < end; (*a)++)
+ if (BMAP_GET(ef->cmap.chunk, *a - EXFAT_FIRST_DATA_CLUSTER))
+ break;
+ if (*a >= end)
+ return 1;
+
+ /* find last contiguous used cluster */
+ for (*b = *a; *b < end; (*b)++)
+ if (BMAP_GET(ef->cmap.chunk, *b - EXFAT_FIRST_DATA_CLUSTER) == 0)
+ {
+ (*b)--;
+ break;
+ }
+
+ return 0;
+}
+
+int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b)
+{
+ cluster_t ca, cb;
+
+ if (*a == 0 && *b == 0)
+ ca = cb = EXFAT_FIRST_DATA_CLUSTER - 1;
+ else
+ {
+ ca = s2c(ef, *a);
+ cb = s2c(ef, *b);
}
+ if (find_used_clusters(ef, &ca, &cb) != 0)
+ return 1;
+ if (*a != 0 || *b != 0)
+ *a = c2s(ef, ca);
+ *b = c2s(ef, cb) + (CLUSTER_SIZE(*ef->sb) - 1) / SECTOR_SIZE(*ef->sb);
return 0;
}