libexfat/cluster.c

   1 /*
   2         cluster.c (03.09.09)
   3         exFAT file system implementation library.
   4
   5         Free exFAT implementation.
   6         Copyright (C) 2010-2013  Andrew Nayenko
   7
   8         This program is free software; you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 2 of the License, or
  11         (at your option) any later version.
  12
  13         This program is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License along
  19         with this program; if not, write to the Free Software Foundation, Inc.,
  20         51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21 */
  22
  23 #include "exfat.h"
  24 #include <errno.h>
  25 #include <string.h>
  26
  27 /*
  28  * Sector to absolute offset.
  29  */
  30 static off_t s2o(const struct exfat* ef, off_t sector)
  31 {
  32         return sector << ef->sb->sector_bits;
  33 }
  34
  35 /*
  36  * Cluster to sector.
  37  */
  38 static off_t c2s(const struct exfat* ef, cluster_t cluster)
  39 {
  40         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
  41                 exfat_bug("invalid cluster number %u", cluster);
  42         return le32_to_cpu(ef->sb->cluster_sector_start) +
  43                 ((off_t) (cluster - EXFAT_FIRST_DATA_CLUSTER) << ef->sb->spc_bits);
  44 }
  45
  46 /*
  47  * Cluster to absolute offset.
  48  */
  49 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster)
  50 {
  51         return s2o(ef, c2s(ef, cluster));
  52 }
  53
  54 /*
  55  * Sector to cluster.
  56  */
  57 static cluster_t s2c(const struct exfat* ef, off_t sector)
  58 {
  59         return ((sector - le32_to_cpu(ef->sb->cluster_sector_start)) >>
  60                         ef->sb->spc_bits) + EXFAT_FIRST_DATA_CLUSTER;
  61 }
  62
  63 /*
  64  * Size in bytes to size in clusters (rounded upwards).
  65  */
  66 static uint32_t bytes2clusters(const struct exfat* ef, uint64_t bytes)
  67 {
  68         uint64_t cluster_size = CLUSTER_SIZE(*ef->sb);
  69         return (bytes + cluster_size - 1) / cluster_size;
  70 }
  71
  72 cluster_t exfat_next_cluster(const struct exfat* ef,
  73                 const struct exfat_node* node, cluster_t cluster)
  74 {
  75         le32_t next;
  76         off_t fat_offset;
  77
  78         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
  79                 exfat_bug("bad cluster 0x%x", cluster);
  80
  81         if (IS_CONTIGUOUS(*node))
  82                 return cluster + 1;
  83         fat_offset = s2o(ef, le32_to_cpu(ef->sb->fat_sector_start))
  84                 + cluster * sizeof(cluster_t);
  85         exfat_pread(ef->dev, &next, sizeof(next), fat_offset);
  86         return le32_to_cpu(next);
  87 }
  88
  89 cluster_t exfat_advance_cluster(const struct exfat* ef,
  90                 struct exfat_node* node, uint32_t count)
  91 {
  92         uint32_t i;
  93
  94         if (node->fptr_index > count)
  95         {
  96                 node->fptr_index = 0;
  97                 node->fptr_cluster = node->start_cluster;
  98         }
  99
 100         for (i = node->fptr_index; i < count; i++)
 101         {
 102                 node->fptr_cluster = exfat_next_cluster(ef, node, node->fptr_cluster);
 103                 if (CLUSTER_INVALID(node->fptr_cluster))
 104                         break; /* the caller should handle this and print appropriate
 105                                   error message */
 106         }
 107         node->fptr_index = count;
 108         return node->fptr_cluster;
 109 }
 110
 111 static cluster_t find_bit_and_set(uint8_t* bitmap, size_t start, size_t end)
 112 {
 113         const size_t start_index = start / 8;
 114         const size_t end_index = DIV_ROUND_UP(end, 8);
 115         size_t i;
 116         size_t c;
 117
 118         for (i = start_index; i < end_index; i++)
 119         {
 120                 if (bitmap[i] == 0xff)
 121                         continue;
 122                 for (c = MAX(i * 8, start); c < MIN((i + 1) * 8, end); c++)
 123                         if (BMAP_GET(bitmap, c) == 0)
 124                         {
 125                                 BMAP_SET(bitmap, c);
 126                                 return c + EXFAT_FIRST_DATA_CLUSTER;
 127                         }
 128         }
 129         return EXFAT_CLUSTER_END;
 130 }
 131
 132 void exfat_flush_cmap(struct exfat* ef)
 133 {
 134         exfat_pwrite(ef->dev, ef->cmap.chunk, (ef->cmap.chunk_size + 7) / 8,
 135                         exfat_c2o(ef, ef->cmap.start_cluster));
 136         ef->cmap.dirty = false;
 137 }
 138
 139 static void set_next_cluster(const struct exfat* ef, bool contiguous,
 140                 cluster_t current, cluster_t next)
 141 {
 142         off_t fat_offset;
 143         le32_t next_le32;
 144
 145         if (contiguous)
 146                 return;
 147         fat_offset = s2o(ef, le32_to_cpu(ef->sb->fat_sector_start))
 148                 + current * sizeof(cluster_t);
 149         next_le32 = cpu_to_le32(next);
 150         exfat_pwrite(ef->dev, &next_le32, sizeof(next_le32), fat_offset);
 151 }
 152
 153 static cluster_t allocate_cluster(struct exfat* ef, cluster_t hint)
 154 {
 155         cluster_t cluster;
 156
 157         hint -= EXFAT_FIRST_DATA_CLUSTER;
 158         if (hint >= ef->cmap.chunk_size)
 159                 hint = 0;
 160
 161         cluster = find_bit_and_set(ef->cmap.chunk, hint, ef->cmap.chunk_size);
 162         if (cluster == EXFAT_CLUSTER_END)
 163                 cluster = find_bit_and_set(ef->cmap.chunk, 0, hint);
 164         if (cluster == EXFAT_CLUSTER_END)
 165         {
 166                 exfat_error("no free space left");
 167                 return EXFAT_CLUSTER_END;
 168         }
 169
 170         ef->cmap.dirty = true;
 171         return cluster;
 172 }
 173
 174 static void free_cluster(struct exfat* ef, cluster_t cluster)
 175 {
 176         if (CLUSTER_INVALID(cluster))
 177                 exfat_bug("freeing invalid cluster 0x%x", cluster);
 178         if (cluster - EXFAT_FIRST_DATA_CLUSTER >= ef->cmap.size)
 179                 exfat_bug("freeing non-existing cluster 0x%x (0x%x)", cluster,
 180                                 ef->cmap.size);
 181
 182         BMAP_CLR(ef->cmap.chunk, cluster - EXFAT_FIRST_DATA_CLUSTER);
 183         ef->cmap.dirty = true;
 184 }
 185
 186 static void make_noncontiguous(const struct exfat* ef, cluster_t first,
 187                 cluster_t last)
 188 {
 189         cluster_t c;
 190
 191         for (c = first; c < last; c++)
 192                 set_next_cluster(ef, false, c, c + 1);
 193 }
 194
 195 static int shrink_file(struct exfat* ef, struct exfat_node* node,
 196                 uint32_t current, uint32_t difference);
 197
 198 static int grow_file(struct exfat* ef, struct exfat_node* node,
 199                 uint32_t current, uint32_t difference)
 200 {
 201         cluster_t previous;
 202         cluster_t next;
 203         uint32_t allocated = 0;
 204
 205         if (difference == 0)
 206                 exfat_bug("zero clusters count passed");
 207
 208         if (node->start_cluster != EXFAT_CLUSTER_FREE)
 209         {
 210                 /* get the last cluster of the file */
 211                 previous = exfat_advance_cluster(ef, node, current - 1);
 212                 if (CLUSTER_INVALID(previous))
 213                 {
 214                         exfat_error("invalid cluster 0x%x while growing", previous);
 215                         return -EIO;
 216                 }
 217         }
 218         else
 219         {
 220                 if (node->fptr_index != 0)
 221                         exfat_bug("non-zero pointer index (%u)", node->fptr_index);
 222                 /* file does not have clusters (i.e. is empty), allocate
 223                    the first one for it */
 224                 previous = allocate_cluster(ef, 0);
 225                 if (CLUSTER_INVALID(previous))
 226                         return -ENOSPC;
 227                 node->fptr_cluster = node->start_cluster = previous;
 228                 allocated = 1;
 229                 /* file consists of only one cluster, so it's contiguous */
 230                 node->flags |= EXFAT_ATTRIB_CONTIGUOUS;
 231         }
 232
 233         while (allocated < difference)
 234         {
 235                 next = allocate_cluster(ef, previous + 1);
 236                 if (CLUSTER_INVALID(next))
 237                 {
 238                         if (allocated != 0)
 239                                 shrink_file(ef, node, current + allocated, allocated);
 240                         return -ENOSPC;
 241                 }
 242                 if (next != previous - 1 && IS_CONTIGUOUS(*node))
 243                 {
 244                         /* it's a pity, but we are not able to keep the file contiguous
 245                            anymore */
 246                         make_noncontiguous(ef, node->start_cluster, previous);
 247                         node->flags &= ~EXFAT_ATTRIB_CONTIGUOUS;
 248                         node->flags |= EXFAT_ATTRIB_DIRTY;
 249                 }
 250                 set_next_cluster(ef, IS_CONTIGUOUS(*node), previous, next);
 251                 previous = next;
 252                 allocated++;
 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 current, uint32_t difference)
 261 {
 262         cluster_t previous;
 263         cluster_t next;
 264
 265         if (difference == 0)
 266                 exfat_bug("zero difference passed");
 267         if (node->start_cluster == EXFAT_CLUSTER_FREE)
 268                 exfat_bug("unable to shrink empty file (%u clusters)", current);
 269         if (current < difference)
 270                 exfat_bug("file underflow (%u < %u)", current, difference);
 271
 272         /* crop the file */
 273         if (current > difference)
 274         {
 275                 cluster_t last = exfat_advance_cluster(ef, node,
 276                                 current - difference - 1);
 277                 if (CLUSTER_INVALID(last))
 278                 {
 279                         exfat_error("invalid cluster 0x%x while shrinking", last);
 280                         return -EIO;
 281                 }
 282                 previous = exfat_next_cluster(ef, node, last);
 283                 set_next_cluster(ef, IS_CONTIGUOUS(*node), last, EXFAT_CLUSTER_END);
 284         }
 285         else
 286         {
 287                 previous = node->start_cluster;
 288                 node->start_cluster = EXFAT_CLUSTER_FREE;
 289         }
 290         node->fptr_index = 0;
 291         node->fptr_cluster = node->start_cluster;
 292
 293         /* free remaining clusters */
 294         while (difference--)
 295         {
 296                 if (CLUSTER_INVALID(previous))
 297                 {
 298                         exfat_error("invalid cluster 0x%x while freeing after shrink",
 299                                         previous);
 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 static void erase_raw(struct exfat* ef, size_t size, off_t offset)
 312 {
 313         exfat_pwrite(ef->dev, ef->zero_cluster, size, offset);
 314 }
 315
 316 static int erase_range(struct exfat* ef, struct exfat_node* node,
 317                 uint64_t begin, uint64_t end)
 318 {
 319         uint64_t cluster_boundary;
 320         cluster_t cluster;
 321
 322         if (begin >= end)
 323                 return 0;
 324
 325         cluster_boundary = (begin | (CLUSTER_SIZE(*ef->sb) - 1)) + 1;
 326         cluster = exfat_advance_cluster(ef, node,
 327                         begin / CLUSTER_SIZE(*ef->sb));
 328         if (CLUSTER_INVALID(cluster))
 329         {
 330                 exfat_error("invalid cluster 0x%x while erasing", cluster);
 331                 return -EIO;
 332         }
 333         /* erase from the beginning to the closest cluster boundary */
 334         erase_raw(ef, MIN(cluster_boundary, end) - begin,
 335                         exfat_c2o(ef, cluster) + begin % CLUSTER_SIZE(*ef->sb));
 336         /* erase whole clusters */
 337         while (cluster_boundary < end)
 338         {
 339                 cluster = exfat_next_cluster(ef, node, cluster);
 340                 /* the cluster cannot be invalid because we have just allocated it */
 341                 if (CLUSTER_INVALID(cluster))
 342                         exfat_bug("invalid cluster 0x%x after allocation", cluster);
 343                 erase_raw(ef, CLUSTER_SIZE(*ef->sb), exfat_c2o(ef, cluster));
 344                 cluster_boundary += CLUSTER_SIZE(*ef->sb);
 345         }
 346         return 0;
 347 }
 348
 349 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
 350                 bool erase)
 351 {
 352         uint32_t c1 = bytes2clusters(ef, node->size);
 353         uint32_t c2 = bytes2clusters(ef, size);
 354         int rc = 0;
 355
 356         if (node->references == 0 && node->parent)
 357                 exfat_bug("no references, node changes can be lost");
 358
 359         if (node->size == size)
 360                 return 0;
 361
 362         if (c1 < c2)
 363                 rc = grow_file(ef, node, c1, c2 - c1);
 364         else if (c1 > c2)
 365                 rc = shrink_file(ef, node, c1, c1 - c2);
 366
 367         if (rc != 0)
 368                 return rc;
 369
 370         if (erase)
 371         {
 372                 rc = erase_range(ef, node, node->size, size);
 373                 if (rc != 0)
 374                         return rc;
 375         }
 376
 377         exfat_update_mtime(node);
 378         node->size = size;
 379         node->flags |= EXFAT_ATTRIB_DIRTY;
 380         return 0;
 381 }
 382
 383 uint32_t exfat_count_free_clusters(const struct exfat* ef)
 384 {
 385         uint32_t free_clusters = 0;
 386         uint32_t i;
 387
 388         for (i = 0; i < ef->cmap.size; i++)
 389                 if (BMAP_GET(ef->cmap.chunk, i) == 0)
 390                         free_clusters++;
 391         return free_clusters;
 392 }
 393
 394 static int find_used_clusters(const struct exfat* ef,
 395                 cluster_t* a, cluster_t* b)
 396 {
 397         const cluster_t end = le32_to_cpu(ef->sb->cluster_count);
 398
 399         /* find first used cluster */
 400         for (*a = *b + 1; *a < end; (*a)++)
 401                 if (BMAP_GET(ef->cmap.chunk, *a - EXFAT_FIRST_DATA_CLUSTER))
 402                         break;
 403         if (*a >= end)
 404                 return 1;
 405
 406         /* find last contiguous used cluster */
 407         for (*b = *a; *b < end; (*b)++)
 408                 if (BMAP_GET(ef->cmap.chunk, *b - EXFAT_FIRST_DATA_CLUSTER) == 0)
 409                 {
 410                         (*b)--;
 411                         break;
 412                 }
 413
 414         return 0;
 415 }
 416
 417 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b)
 418 {
 419         cluster_t ca, cb;
 420
 421         if (*a == 0 && *b == 0)
 422                 ca = cb = EXFAT_FIRST_DATA_CLUSTER - 1;
 423         else
 424         {
 425                 ca = s2c(ef, *a);
 426                 cb = s2c(ef, *b);
 427         }
 428         if (find_used_clusters(ef, &ca, &cb) != 0)
 429                 return 1;
 430         if (*a != 0 || *b != 0)
 431                 *a = c2s(ef, ca);
 432         *b = c2s(ef, cb) + (CLUSTER_SIZE(*ef->sb) - 1) / SECTOR_SIZE(*ef->sb);
 433         return 0;
 434 }