libexfat/cluster.c

   1 /*
   2         cluster.c (03.09.09)
   3         exFAT file system implementation library.
   4
   5         Copyright (C) 2009, 2010  Andrew Nayenko
   6
   7         This program is free software: you can redistribute it and/or modify
   8         it under the terms of the GNU General Public License as published by
   9         the Free Software Foundation, either version 3 of the License, or
  10         (at your option) any later version.
  11
  12         This program is distributed in the hope that it will be useful,
  13         but WITHOUT ANY WARRANTY; without even the implied warranty of
  14         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15         GNU General Public License for more details.
  16
  17         You should have received a copy of the GNU General Public License
  18         along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "exfat.h"
  22 #include <errno.h>
  23 #include <string.h>
  24
  25 #define BMAP_GET(bitmap, index) ((bitmap)[(index) / 8] & (1u << ((index) % 8)))
  26 #define BMAP_SET(bitmap, index) (bitmap)[(index) / 8] |= (1u << ((index) % 8))
  27 #define BMAP_CLR(bitmap, index) (bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
  28
  29 /*
  30  * Cluster to block.
  31  */
  32 static uint32_t c2b(const struct exfat* ef, cluster_t cluster)
  33 {
  34         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
  35                 exfat_bug("invalid cluster number %u", cluster);
  36         return le32_to_cpu(ef->sb->cluster_block_start) +
  37                 ((cluster - EXFAT_FIRST_DATA_CLUSTER) << ef->sb->bpc_bits);
  38 }
  39
  40 /*
  41  * Cluster to absolute offset.
  42  */
  43 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster)
  44 {
  45         return (off_t) c2b(ef, cluster) << ef->sb->block_bits;
  46 }
  47
  48 /*
  49  * Block to absolute offset.
  50  */
  51 static off_t b2o(const struct exfat* ef, uint32_t block)
  52 {
  53         return (off_t) block << ef->sb->block_bits;
  54 }
  55
  56 /*
  57  * Size in bytes to size in clusters (rounded upwards).
  58  */
  59 static uint32_t bytes2clusters(const struct exfat* ef, uint64_t bytes)
  60 {
  61         uint64_t cluster_size = CLUSTER_SIZE(*ef->sb);
  62         return (bytes + cluster_size - 1) / cluster_size;
  63 }
  64
  65 cluster_t exfat_next_cluster(const struct exfat* ef,
  66                 const struct exfat_node* node, cluster_t cluster)
  67 {
  68         cluster_t next;
  69         off_t fat_offset;
  70
  71         if (cluster < EXFAT_FIRST_DATA_CLUSTER)
  72                 exfat_bug("bad cluster 0x%x", cluster);
  73
  74         if (IS_CONTIGUOUS(*node))
  75                 return cluster + 1;
  76         fat_offset = b2o(ef, le32_to_cpu(ef->sb->fat_block_start))
  77                 + cluster * sizeof(cluster_t);
  78         exfat_read_raw(&next, sizeof(next), fat_offset, ef->fd);
  79         return next;
  80 }
  81
  82 cluster_t exfat_advance_cluster(const struct exfat* ef,
  83                 struct exfat_node* node, uint32_t count)
  84 {
  85         uint32_t i;
  86
  87         if (node->fptr_index > count)
  88         {
  89                 node->fptr_index = 0;
  90                 node->fptr_cluster = node->start_cluster;
  91         }
  92
  93         for (i = node->fptr_index; i < count; i++)
  94         {
  95                 node->fptr_cluster = exfat_next_cluster(ef, node, node->fptr_cluster);
  96                 if (CLUSTER_INVALID(node->fptr_cluster))
  97                         break;
  98         }
  99         node->fptr_index = count;
 100         return node->fptr_cluster;
 101 }
 102
 103 static cluster_t find_bit_and_set(uint8_t* bitmap, cluster_t start,
 104                 cluster_t end)
 105 {
 106         const cluster_t mid_start = (start + 7) / 8 * 8;
 107         const cluster_t mid_end = end / 8 * 8;
 108         cluster_t c;
 109         cluster_t byte;
 110
 111         for (c = start; c < mid_start; c++)
 112                 if (BMAP_GET(bitmap, c) == 0)
 113                 {
 114                         BMAP_SET(bitmap, c);
 115                         return c + EXFAT_FIRST_DATA_CLUSTER;
 116                 }
 117
 118         for (byte = mid_start / 8; byte < mid_end / 8; byte++)
 119                 if (bitmap[byte] != 0xff)
 120                 {
 121                         cluster_t bit;
 122
 123                         for (bit = 0; bit < 8; bit++)
 124                                 if (!(bitmap[byte] & (1u << bit)))
 125                                 {
 126                                         bitmap[byte] |= (1u << bit);
 127                                         return byte * 8 + bit + EXFAT_FIRST_DATA_CLUSTER;
 128                                 }
 129                 }
 130
 131         for (c = mid_end; c < end; c++)
 132                 if (BMAP_GET(bitmap, c) == 0)
 133                 {
 134                         BMAP_SET(bitmap, c);
 135                         return c + EXFAT_FIRST_DATA_CLUSTER;
 136                 }
 137
 138         return EXFAT_CLUSTER_END;
 139 }
 140
 141 void exfat_flush_cmap(struct exfat* ef)
 142 {
 143         exfat_write_raw(ef->cmap.chunk, (ef->cmap.chunk_size + 7) / 8,
 144                         exfat_c2o(ef, ef->cmap.start_cluster), ef->fd);
 145         ef->cmap.dirty = 0;
 146 }
 147
 148 static void set_next_cluster(const struct exfat* ef, int contiguous,
 149                 cluster_t current, cluster_t next)
 150 {
 151         off_t fat_offset;
 152
 153         if (contiguous)
 154                 return;
 155         fat_offset = b2o(ef, le32_to_cpu(ef->sb->fat_block_start))
 156                 + current * sizeof(cluster_t);
 157         exfat_write_raw(&next, sizeof(next), fat_offset, ef->fd);
 158 }
 159
 160 static cluster_t allocate_cluster(struct exfat* ef, cluster_t hint)
 161 {
 162         cluster_t cluster;
 163
 164         hint -= EXFAT_FIRST_DATA_CLUSTER;
 165         if (hint >= ef->cmap.chunk_size)
 166                 hint = 0;
 167
 168         cluster = find_bit_and_set(ef->cmap.chunk, hint, ef->cmap.chunk_size);
 169         if (cluster == EXFAT_CLUSTER_END)
 170                 cluster = find_bit_and_set(ef->cmap.chunk, 0, hint);
 171         if (cluster == EXFAT_CLUSTER_END)
 172         {
 173                 exfat_error("no free space left");
 174                 return EXFAT_CLUSTER_END;
 175         }
 176
 177         ef->cmap.dirty = 1;
 178         /* FIXME update percentage of used space */
 179         return cluster;
 180 }
 181
 182 static void free_cluster(struct exfat* ef, cluster_t cluster)
 183 {
 184         if (CLUSTER_INVALID(cluster))
 185                 exfat_bug("attempting to free invalid cluster");
 186         if (cluster < EXFAT_FIRST_DATA_CLUSTER ||
 187                 cluster - EXFAT_FIRST_DATA_CLUSTER >= ef->cmap.size)
 188                 exfat_bug("bad cluster 0x%x (0x%x)", cluster, ef->cmap.size);
 189
 190         BMAP_CLR(ef->cmap.chunk, cluster - EXFAT_FIRST_DATA_CLUSTER);
 191         ef->cmap.dirty = 1;
 192         /* FIXME update percentage of used space */
 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 static void erase_raw(struct exfat* ef, size_t size, off_t offset)
 312 {
 313         exfat_write_raw(ef->zero_block, size, offset, ef->fd);
 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 block_boundary;
 320         cluster_t cluster;
 321
 322         if (begin >= end)
 323                 return 0;
 324
 325         block_boundary = (node->size | (BLOCK_SIZE(*ef->sb) - 1)) + 1;
 326         cluster = exfat_advance_cluster(ef, node,
 327                         node->size / CLUSTER_SIZE(*ef->sb));
 328         if (CLUSTER_INVALID(cluster))
 329         {
 330                 exfat_error("invalid cluster in file");
 331                 return -EIO;
 332         }
 333         /* erase from the beginning to the closest block boundary */
 334         erase_raw(ef, MIN(block_boundary, end) - node->size,
 335                         exfat_c2o(ef, cluster) + node->size % CLUSTER_SIZE(*ef->sb));
 336         /* erase whole blocks */
 337         while (block_boundary < end)
 338         {
 339                 if (block_boundary % CLUSTER_SIZE(*ef->sb) == 0)
 340                         cluster = exfat_next_cluster(ef, node, cluster);
 341                 erase_raw(ef, BLOCK_SIZE(*ef->sb),
 342                         exfat_c2o(ef, cluster) + block_boundary % CLUSTER_SIZE(*ef->sb));
 343                 block_boundary += BLOCK_SIZE(*ef->sb);
 344         }
 345         return 0;
 346 }
 347
 348 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size)
 349 {
 350         uint32_t c1 = bytes2clusters(ef, node->size);
 351         uint32_t c2 = bytes2clusters(ef, size);
 352         int rc = 0;
 353
 354         if (node->size == size)
 355                 return 0;
 356
 357         if (c1 < c2)
 358                 rc = grow_file(ef, node, c2 - c1);
 359         else if (c1 > c2)
 360                 rc = shrink_file(ef, node, c1 - c2);
 361
 362         if (rc != 0)
 363                 return rc;
 364
 365         rc = erase_range(ef, node, node->size, size);
 366         if (rc != 0)
 367                 return rc;
 368
 369         exfat_update_mtime(node);
 370         node->size = size;
 371         node->flags |= EXFAT_ATTRIB_DIRTY;
 372         return 0;
 373 }