libexfat/cluster.c

   1 /*
   2  *  cluster.c
   3  *  exFAT file system implementation library.
   4  *
   5  *  Created by Andrew Nayenko on 03.09.09.
   6  *  This software is distributed under the GNU General Public License
   7  *  version 3 or any later.
   8  */
   9
  10 #include "exfat.h"
  11 #include <errno.h>
  12 #include <string.h>
  13
  14 #define BMAP_GET(bitmap, index) ((bitmap)[(index) / 8] & (1u << ((index) % 8)))
  15 #define BMAP_SET(bitmap, index) (bitmap)[(index) / 8] |= (1u << ((index) % 8))
  16 #define BMAP_CLR(bitmap, index) (bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
  17
  18 /*
  19  * Cluster to block.
  20  */
  21 static uint32_t c2b(const struct exfat* ef, cluster_t cluster)
  22 {
  23         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
  24                 exfat_bug("invalid cluster number %u", cluster);
  25         return le32_to_cpu(ef->sb->cluster_block_start) +
  26                 ((cluster - EXFAT_FIRST_DATA_CLUSTER) << ef->sb->bpc_bits);
  27 }
  28
  29 /*
  30  * Cluster to absolute offset.
  31  */
  32 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster)
  33 {
  34         return (off_t) c2b(ef, cluster) << ef->sb->block_bits;
  35 }
  36
  37 /*
  38  * Block to absolute offset.
  39  */
  40 static off_t b2o(const struct exfat* ef, uint32_t block)
  41 {
  42         return (off_t) block << ef->sb->block_bits;
  43 }
  44
  45 /*
  46  * Size in bytes to size in clusters (rounded upwards).
  47  */
  48 static uint32_t bytes2clusters(const struct exfat* ef, uint64_t bytes)
  49 {
  50         uint64_t cluster_size = CLUSTER_SIZE(*ef->sb);
  51         return (bytes + cluster_size - 1) / cluster_size;
  52 }
  53
  54 cluster_t exfat_next_cluster(const struct exfat* ef,
  55                 const struct exfat_node* node, cluster_t cluster)
  56 {
  57         cluster_t next;
  58         off_t fat_offset;
  59
  60         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
  61                 exfat_bug("bad cluster 0x%x", cluster);
  62
  63         if (IS_CONTIGUOUS(*node))
  64                 return cluster + 1;
  65         fat_offset = b2o(ef, le32_to_cpu(ef->sb->fat_block_start))
  66                 + cluster * sizeof(cluster_t);
  67         exfat_read_raw(&next, sizeof(next), fat_offset, ef->fd);
  68         return next;
  69 }
  70
  71 cluster_t exfat_advance_cluster(const struct exfat* ef,
  72                 struct exfat_node* node, uint32_t count)
  73 {
  74         uint32_t i;
  75
  76         if (node->fptr_index > count)
  77         {
  78                 node->fptr_index = 0;
  79                 node->fptr_cluster = node->start_cluster;
  80         }
  81
  82         for (i = node->fptr_index; i < count; i++)
  83         {
  84                 node->fptr_cluster = exfat_next_cluster(ef, node, node->fptr_cluster);
  85                 if (CLUSTER_INVALID(node->fptr_cluster))
  86                         break;
  87         }
  88         node->fptr_index = count;
  89         return node->fptr_cluster;
  90 }
  91
  92 static cluster_t find_bit_and_set(uint8_t* bitmap, cluster_t start,
  93                 cluster_t end)
  94 {
  95         const cluster_t mid_start = (start + 7) / 8 * 8;
  96         const cluster_t mid_end = end / 8 * 8;
  97         cluster_t c;
  98         cluster_t byte;
  99
 100         for (c = start; c < mid_start; c++)
 101                 if (BMAP_GET(bitmap, c) == 0)
 102                 {
 103                         BMAP_SET(bitmap, c);
 104                         return c + EXFAT_FIRST_DATA_CLUSTER;
 105                 }
 106
 107         for (byte = mid_start / 8; byte < mid_end / 8; byte++)
 108                 if (bitmap[byte] != 0xff)
 109                 {
 110                         cluster_t bit;
 111
 112                         for (bit = 0; bit < 8; bit++)
 113                                 if (!(bitmap[byte] & (1u << bit)))
 114                                 {
 115                                         bitmap[byte] |= (1u << bit);
 116                                         return byte * 8 + bit + EXFAT_FIRST_DATA_CLUSTER;
 117                                 }
 118                 }
 119
 120         for (c = mid_end; c < end; c++)
 121                 if (BMAP_GET(bitmap, c) == 0)
 122                 {
 123                         BMAP_SET(bitmap, c);
 124                         return c + EXFAT_FIRST_DATA_CLUSTER;
 125                 }
 126
 127         return EXFAT_CLUSTER_END;
 128 }
 129
 130 static void flush_cmap(struct exfat* ef)
 131 {
 132         exfat_write_raw(ef->cmap.chunk, (ef->cmap.chunk_size + 7) / 8,
 133                         exfat_c2o(ef, ef->cmap.start_cluster), ef->fd);
 134 }
 135
 136 static void set_next_cluster(const struct exfat* ef, int contiguous,
 137                 cluster_t current, cluster_t next)
 138 {
 139         off_t fat_offset;
 140
 141         if (contiguous)
 142                 return;
 143         fat_offset = b2o(ef, le32_to_cpu(ef->sb->fat_block_start))
 144                 + current * sizeof(cluster_t);
 145         exfat_write_raw(&next, sizeof(next), fat_offset, ef->fd);
 146 }
 147
 148 static void erase_cluster(struct exfat* ef, cluster_t cluster)
 149 {
 150         const int block_size = BLOCK_SIZE(*ef->sb);
 151         const int blocks_in_cluster = CLUSTER_SIZE(*ef->sb) / block_size;
 152         int i;
 153
 154         for (i = 0; i < blocks_in_cluster; i++)
 155                 exfat_write_raw(ef->zero_block, block_size,
 156                                 exfat_c2o(ef, cluster) + i * block_size, ef->fd);
 157 }
 158
 159 static cluster_t allocate_cluster(struct exfat* ef, cluster_t hint)
 160 {
 161         cluster_t cluster;
 162
 163         hint -= EXFAT_FIRST_DATA_CLUSTER;
 164         if (hint >= ef->cmap.chunk_size)
 165                 hint = 0;
 166
 167         cluster = find_bit_and_set(ef->cmap.chunk, hint, ef->cmap.chunk_size);
 168         if (cluster == EXFAT_CLUSTER_END)
 169                 cluster = find_bit_and_set(ef->cmap.chunk, 0, hint);
 170         if (cluster == EXFAT_CLUSTER_END)
 171         {
 172                 exfat_error("no free space left");
 173                 return EXFAT_CLUSTER_END;
 174         }
 175
 176         erase_cluster(ef, cluster);
 177         /* FIXME no need to flush immediately */
 178         flush_cmap(ef);
 179         /* FIXME update percentage of used space */
 180         return cluster;
 181 }
 182
 183 static void free_cluster(struct exfat* ef, cluster_t cluster)
 184 {
 185         if (CLUSTER_INVALID(cluster))
 186                 exfat_bug("attempting to free invalid cluster");
 187
 188         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
 189                 exfat_bug("bad cluster 0x%x", cluster);
 190         BMAP_CLR(ef->cmap.chunk, cluster - EXFAT_FIRST_DATA_CLUSTER);
 191         /* FIXME no need to flush immediately */
 192         flush_cmap(ef);
 193 }
 194
 195 static void make_noncontiguous(const struct exfat* ef, cluster_t first,
 196                 cluster_t last)
 197 {
 198         cluster_t c;
 199
 200         for (c = first; c < last; c++)
 201                 set_next_cluster(ef, 0, c, c + 1);
 202 }
 203
 204 static int grow_file(struct exfat* ef, struct exfat_node* node,
 205                 uint32_t difference)
 206 {
 207         cluster_t previous;
 208         cluster_t next;
 209
 210         if (difference == 0)
 211                 exfat_bug("zero clusters count passed");
 212
 213         if (node->start_cluster != EXFAT_CLUSTER_FREE)
 214         {
 215                 /* get the last cluster of the file */
 216                 previous = exfat_advance_cluster(ef, node,
 217                                 bytes2clusters(ef, node->size) - 1);
 218                 if (CLUSTER_INVALID(previous))
 219                 {
 220                         exfat_error("invalid cluster in file");
 221                         return -EIO;
 222                 }
 223         }
 224         else
 225         {
 226                 if (node->fptr_index != 0)
 227                         exfat_bug("non-zero pointer index (%u)", node->fptr_index);
 228                 /* file does not have clusters (i.e. is empty), allocate
 229                    the first one for it */
 230                 previous = allocate_cluster(ef, 0);
 231                 if (CLUSTER_INVALID(previous))
 232                         return -ENOSPC;
 233                 node->fptr_cluster = node->start_cluster = previous;
 234                 difference--;
 235                 /* file consists of only one cluster, so it's contiguous */
 236                 node->flags |= EXFAT_ATTRIB_CONTIGUOUS;
 237         }
 238
 239         while (difference--)
 240         {
 241                 next = allocate_cluster(ef, previous + 1);
 242                 if (CLUSTER_INVALID(next))
 243                         return -ENOSPC;
 244                 if (next != previous - 1 && IS_CONTIGUOUS(*node))
 245                 {
 246                         /* it's a pity, but we are not able to keep the file contiguous
 247                            anymore */
 248                         make_noncontiguous(ef, node->start_cluster, previous);
 249                         node->flags &= ~EXFAT_ATTRIB_CONTIGUOUS;
 250                 }
 251                 set_next_cluster(ef, IS_CONTIGUOUS(*node), previous, next);
 252                 previous = next;
 253         }
 254
 255         set_next_cluster(ef, IS_CONTIGUOUS(*node), previous, EXFAT_CLUSTER_END);
 256         return 0;
 257 }
 258
 259 static int shrink_file(struct exfat* ef, struct exfat_node* node,
 260                 uint32_t difference)
 261 {
 262         uint32_t current = bytes2clusters(ef, node->size);
 263         cluster_t previous;
 264         cluster_t next;
 265
 266         if (difference == 0)
 267                 exfat_bug("zero difference passed");
 268         if (node->start_cluster == EXFAT_CLUSTER_FREE)
 269                 exfat_bug("unable to shrink empty file (%u clusters)", current);
 270         if (current < difference)
 271                 exfat_bug("file underflow (%u < %u)", current, difference);
 272
 273         /* crop the file */
 274         if (current > difference)
 275         {
 276                 cluster_t last = exfat_advance_cluster(ef, node,
 277                                 current - difference - 1);
 278                 if (CLUSTER_INVALID(last))
 279                 {
 280                         exfat_error("invalid cluster in file");
 281                         return -EIO;
 282                 }
 283                 previous = exfat_next_cluster(ef, node, last);
 284                 set_next_cluster(ef, IS_CONTIGUOUS(*node), last, EXFAT_CLUSTER_END);
 285         }
 286         else
 287         {
 288                 previous = node->start_cluster;
 289                 node->start_cluster = EXFAT_CLUSTER_FREE;
 290         }
 291         node->fptr_index = 0;
 292         node->fptr_cluster = node->start_cluster;
 293
 294         /* free remaining clusters */
 295         while (difference--)
 296         {
 297                 if (CLUSTER_INVALID(previous))
 298                 {
 299                         exfat_error("invalid cluster in file");
 300                         return -EIO;
 301                 }
 302                 next = exfat_next_cluster(ef, node, previous);
 303                 set_next_cluster(ef, IS_CONTIGUOUS(*node), previous,
 304                                 EXFAT_CLUSTER_FREE);
 305                 free_cluster(ef, previous);
 306                 previous = next;
 307         }
 308         return 0;
 309 }
 310
 311 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size)
 312 {
 313         uint32_t c1 = bytes2clusters(ef, node->size);
 314         uint32_t c2 = bytes2clusters(ef, size);
 315         int rc = 0;
 316
 317         if (c1 < c2)
 318                 rc = grow_file(ef, node, c2 - c1);
 319         else if (c1 > c2)
 320                 rc = shrink_file(ef, node, c1 - c2);
 321
 322         if (rc != 0)
 323                 return rc;
 324
 325         if (node->size != size)
 326         {
 327                 node->size = size;
 328                 node->flags |= EXFAT_ATTRIB_DIRTY;
 329         }
 330         return 0;
 331 }