lib/ext2fs/gen_bitmap.c

   1 /*
   2  * gen_bitmap.c --- Generic (32-bit) bitmap routines
   3  *
   4  * Copyright (C) 2001 Theodore Ts'o.
   5  *
   6  * %Begin-Header%
   7  * This file may be redistributed under the terms of the GNU Public
   8  * License.
   9  * %End-Header%
  10  */
  11
  12
  13 #include <stdio.h>
  14 #include <string.h>
  15 #if HAVE_UNISTD_H
  16 #include <unistd.h>
  17 #endif
  18 #include <fcntl.h>
  19 #include <time.h>
  20 #if HAVE_SYS_STAT_H
  21 #include <sys/stat.h>
  22 #endif
  23 #if HAVE_SYS_TYPES_H
  24 #include <sys/types.h>
  25 #endif
  26
  27 #include "ext2_fs.h"
  28 #include "ext2fs.h"
  29
  30 struct ext2fs_struct_generic_bitmap {
  31         errcode_t       magic;
  32         ext2_filsys     fs;
  33         __u32           start, end;
  34         __u32           real_end;
  35         char    *       description;
  36         char    *       bitmap;
  37         errcode_t       base_error_code;
  38         __u32           reserved[7];
  39 };
  40
  41 /*
  42  * Used by previously inlined function, so we have to export this and
  43  * not change the function signature
  44  */
  45 void ext2fs_warn_bitmap2(ext2fs_generic_bitmap bitmap,
  46                             int code, unsigned long arg)
  47 {
  48 #ifndef OMIT_COM_ERR
  49         if (bitmap->description)
  50                 com_err(0, bitmap->base_error_code+code,
  51                         "#%lu for %s", arg, bitmap->description);
  52         else
  53                 com_err(0, bitmap->base_error_code + code, "#%lu", arg);
  54 #endif
  55 }
  56
  57 static errcode_t check_magic(ext2fs_generic_bitmap bitmap)
  58 {
  59         if (!bitmap || !((bitmap->magic == EXT2_ET_MAGIC_GENERIC_BITMAP) ||
  60                          (bitmap->magic == EXT2_ET_MAGIC_INODE_BITMAP) ||
  61                          (bitmap->magic == EXT2_ET_MAGIC_BLOCK_BITMAP)))
  62                 return EXT2_ET_MAGIC_GENERIC_BITMAP;
  63         return 0;
  64 }
  65
  66 errcode_t ext2fs_make_generic_bitmap(errcode_t magic, ext2_filsys fs,
  67                                      __u32 start, __u32 end, __u32 real_end,
  68                                      const char *descr, char *init_map,
  69                                      ext2fs_generic_bitmap *ret)
  70 {
  71         ext2fs_generic_bitmap   bitmap;
  72         errcode_t               retval;
  73         size_t                  size;
  74
  75         retval = ext2fs_get_mem(sizeof(struct ext2fs_struct_generic_bitmap),
  76                                 &bitmap);
  77         if (retval)
  78                 return retval;
  79
  80         bitmap->magic = magic;
  81         bitmap->fs = fs;
  82         bitmap->start = start;
  83         bitmap->end = end;
  84         bitmap->real_end = real_end;
  85         switch (magic) {
  86         case EXT2_ET_MAGIC_INODE_BITMAP:
  87                 bitmap->base_error_code = EXT2_ET_BAD_INODE_MARK;
  88                 break;
  89         case EXT2_ET_MAGIC_BLOCK_BITMAP:
  90                 bitmap->base_error_code = EXT2_ET_BAD_BLOCK_MARK;
  91                 break;
  92         default:
  93                 bitmap->base_error_code = EXT2_ET_BAD_GENERIC_MARK;
  94         }
  95         if (descr) {
  96                 retval = ext2fs_get_mem(strlen(descr)+1, &bitmap->description);
  97                 if (retval) {
  98                         ext2fs_free_mem(&bitmap);
  99                         return retval;
 100                 }
 101                 strcpy(bitmap->description, descr);
 102         } else
 103                 bitmap->description = 0;
 104
 105         size = (size_t) (((bitmap->real_end - bitmap->start) / 8) + 1);
 106         retval = ext2fs_get_mem(size, &bitmap->bitmap);
 107         if (retval) {
 108                 ext2fs_free_mem(&bitmap->description);
 109                 ext2fs_free_mem(&bitmap);
 110                 return retval;
 111         }
 112
 113         if (init_map)
 114                 memcpy(bitmap->bitmap, init_map, size);
 115         else
 116                 memset(bitmap->bitmap, 0, size);
 117         *ret = bitmap;
 118         return 0;
 119 }
 120
 121 errcode_t ext2fs_allocate_generic_bitmap(__u32 start,
 122                                          __u32 end,
 123                                          __u32 real_end,
 124                                          const char *descr,
 125                                          ext2fs_generic_bitmap *ret)
 126 {
 127         return ext2fs_make_generic_bitmap(EXT2_ET_MAGIC_GENERIC_BITMAP, 0,
 128                                           start, end, real_end, descr, 0, ret);
 129 }
 130
 131 errcode_t ext2fs_copy_generic_bitmap(ext2fs_generic_bitmap src,
 132                                      ext2fs_generic_bitmap *dest)
 133 {
 134         return (ext2fs_make_generic_bitmap(src->magic, src->fs,
 135                                            src->start, src->end,
 136                                            src->real_end,
 137                                            src->description, src->bitmap,
 138                                            dest));
 139 }
 140
 141 void ext2fs_free_generic_bitmap(ext2fs_inode_bitmap bitmap)
 142 {
 143         if (check_magic(bitmap))
 144                 return;
 145
 146         bitmap->magic = 0;
 147         if (bitmap->description) {
 148                 ext2fs_free_mem(&bitmap->description);
 149                 bitmap->description = 0;
 150         }
 151         if (bitmap->bitmap) {
 152                 ext2fs_free_mem(&bitmap->bitmap);
 153                 bitmap->bitmap = 0;
 154         }
 155         ext2fs_free_mem(&bitmap);
 156 }
 157
 158 int ext2fs_test_generic_bitmap(ext2fs_generic_bitmap bitmap,
 159                                         blk_t bitno)
 160 {
 161         if ((bitno < bitmap->start) || (bitno > bitmap->end)) {
 162                 ext2fs_warn_bitmap2(bitmap, EXT2FS_TEST_ERROR, bitno);
 163                 return 0;
 164         }
 165         return ext2fs_test_bit(bitno - bitmap->start, bitmap->bitmap);
 166 }
 167
 168 int ext2fs_mark_generic_bitmap(ext2fs_generic_bitmap bitmap,
 169                                          __u32 bitno)
 170 {
 171         if ((bitno < bitmap->start) || (bitno > bitmap->end)) {
 172                 ext2fs_warn_bitmap2(bitmap, EXT2FS_MARK_ERROR, bitno);
 173                 return 0;
 174         }
 175         return ext2fs_set_bit(bitno - bitmap->start, bitmap->bitmap);
 176 }
 177
 178 int ext2fs_unmark_generic_bitmap(ext2fs_generic_bitmap bitmap,
 179                                            blk_t bitno)
 180 {
 181         if ((bitno < bitmap->start) || (bitno > bitmap->end)) {
 182                 ext2fs_warn_bitmap2(bitmap, EXT2FS_UNMARK_ERROR, bitno);
 183                 return 0;
 184         }
 185         return ext2fs_clear_bit(bitno - bitmap->start, bitmap->bitmap);
 186 }
 187
 188 __u32 ext2fs_get_generic_bitmap_start(ext2fs_generic_bitmap bitmap)
 189 {
 190         return bitmap->start;
 191 }
 192
 193 __u32 ext2fs_get_generic_bitmap_end(ext2fs_generic_bitmap bitmap)
 194 {
 195         return bitmap->end;
 196 }
 197
 198 void ext2fs_clear_generic_bitmap(ext2fs_generic_bitmap bitmap)
 199 {
 200         if (check_magic(bitmap))
 201                 return;
 202
 203         memset(bitmap->bitmap, 0,
 204                (size_t) (((bitmap->real_end - bitmap->start) / 8) + 1));
 205 }
 206
 207 errcode_t ext2fs_fudge_generic_bitmap_end(ext2fs_inode_bitmap bitmap,
 208                                           errcode_t magic, errcode_t neq,
 209                                           ext2_ino_t end, ext2_ino_t *oend)
 210 {
 211         EXT2_CHECK_MAGIC(bitmap, magic);
 212
 213         if (end > bitmap->real_end)
 214                 return neq;
 215         if (oend)
 216                 *oend = bitmap->end;
 217         bitmap->end = end;
 218         return 0;
 219 }
 220
 221 errcode_t ext2fs_resize_generic_bitmap(errcode_t magic,
 222                                        __u32 new_end, __u32 new_real_end,
 223                                        ext2fs_generic_bitmap bmap)
 224 {
 225         errcode_t       retval;
 226         size_t          size, new_size;
 227         __u32           bitno;
 228
 229         if (!bmap || (bmap->magic != magic))
 230                 return magic;
 231
 232         /*
 233          * If we're expanding the bitmap, make sure all of the new
 234          * parts of the bitmap are zero.
 235          */
 236         if (new_end > bmap->end) {
 237                 bitno = bmap->real_end;
 238                 if (bitno > new_end)
 239                         bitno = new_end;
 240                 for (; bitno > bmap->end; bitno--)
 241                         ext2fs_clear_bit(bitno - bmap->start, bmap->bitmap);
 242         }
 243         if (new_real_end == bmap->real_end) {
 244                 bmap->end = new_end;
 245                 return 0;
 246         }
 247
 248         size = ((bmap->real_end - bmap->start) / 8) + 1;
 249         new_size = ((new_real_end - bmap->start) / 8) + 1;
 250
 251         if (size != new_size) {
 252                 retval = ext2fs_resize_mem(size, new_size, &bmap->bitmap);
 253                 if (retval)
 254                         return retval;
 255         }
 256         if (new_size > size)
 257                 memset(bmap->bitmap + size, 0, new_size - size);
 258
 259         bmap->end = new_end;
 260         bmap->real_end = new_real_end;
 261         return 0;
 262 }
 263
 264 errcode_t ext2fs_compare_generic_bitmap(errcode_t magic, errcode_t neq,
 265                                         ext2fs_generic_bitmap bm1,
 266                                         ext2fs_generic_bitmap bm2)
 267 {
 268         blk_t   i;
 269
 270         if (!bm1 || bm1->magic != magic)
 271                 return magic;
 272         if (!bm2 || bm2->magic != magic)
 273                 return magic;
 274
 275         if ((bm1->start != bm2->start) ||
 276             (bm1->end != bm2->end) ||
 277             (memcmp(bm1->bitmap, bm2->bitmap,
 278                     (size_t) (bm1->end - bm1->start)/8)))
 279                 return neq;
 280
 281         for (i = bm1->end - ((bm1->end - bm1->start) % 8); i <= bm1->end; i++)
 282                 if (ext2fs_fast_test_block_bitmap(bm1, i) !=
 283                     ext2fs_fast_test_block_bitmap(bm2, i))
 284                         return neq;
 285
 286         return 0;
 287 }
 288
 289 void ext2fs_set_generic_bitmap_padding(ext2fs_generic_bitmap map)
 290 {
 291         __u32   i, j;
 292
 293         /* Protect loop from wrap-around if map->real_end is maxed */
 294         for (i=map->end+1, j = i - map->start;
 295              i <= map->real_end && i > map->end;
 296              i++, j++)
 297                 ext2fs_set_bit(j, map->bitmap);
 298 }
 299
 300 errcode_t ext2fs_get_generic_bitmap_range(ext2fs_generic_bitmap bmap,
 301                                           errcode_t magic,
 302                                           __u32 start, __u32 num,
 303                                           void *out)
 304 {
 305         if (!bmap || (bmap->magic != magic))
 306                 return magic;
 307
 308         if ((start < bmap->start) || (start+num-1 > bmap->real_end))
 309                 return EXT2_ET_INVALID_ARGUMENT;
 310
 311         memcpy(out, bmap->bitmap + (start >> 3), (num+7) >> 3);
 312         return 0;
 313 }
 314
 315 errcode_t ext2fs_set_generic_bitmap_range(ext2fs_generic_bitmap bmap,
 316                                           errcode_t magic,
 317                                           __u32 start, __u32 num,
 318                                           void *in)
 319 {
 320         if (!bmap || (bmap->magic != magic))
 321                 return magic;
 322
 323         if ((start < bmap->start) || (start+num-1 > bmap->real_end))
 324                 return EXT2_ET_INVALID_ARGUMENT;
 325
 326         memcpy(bmap->bitmap + (start >> 3), in, (num+7) >> 3);
 327         return 0;
 328 }
 329
 330 /*
 331  * Compare @mem to zero buffer by 256 bytes.
 332  * Return 1 if @mem is zeroed memory, otherwise return 0.
 333  */
 334 static int mem_is_zero(const char *mem, size_t len)
 335 {
 336         static const char zero_buf[256];
 337
 338         while (len >= sizeof(zero_buf)) {
 339                 if (memcmp(mem, zero_buf, sizeof(zero_buf)))
 340                         return 0;
 341                 len -= sizeof(zero_buf);
 342                 mem += sizeof(zero_buf);
 343         }
 344         /* Deal with leftover bytes. */
 345         if (len)
 346                 return !memcmp(mem, zero_buf, len);
 347         return 1;
 348 }
 349
 350 /*
 351  * Return true if all of the bits in a specified range are clear
 352  */
 353 static int ext2fs_test_clear_generic_bitmap_range(ext2fs_generic_bitmap bitmap,
 354                                                   unsigned int start,
 355                                                   unsigned int len)
 356 {
 357         size_t start_byte, len_byte = len >> 3;
 358         unsigned int start_bit, len_bit = len % 8;
 359         int first_bit = 0;
 360         int last_bit  = 0;
 361         int mark_count = 0;
 362         int mark_bit = 0;
 363         int i;
 364         const char *ADDR = bitmap->bitmap;
 365
 366         start -= bitmap->start;
 367         start_byte = start >> 3;
 368         start_bit = start % 8;
 369
 370         if (start_bit != 0) {
 371                 /*
 372                  * The compared start block number or start inode number
 373                  * is not the first bit in a byte.
 374                  */
 375                 mark_count = 8 - start_bit;
 376                 if (len < 8 - start_bit) {
 377                         mark_count = (int)len;
 378                         mark_bit = len + start_bit - 1;
 379                 } else
 380                         mark_bit = 7;
 381
 382                 for (i = mark_count; i > 0; i--, mark_bit--)
 383                         first_bit |= 1 << mark_bit;
 384
 385                 /*
 386                  * Compare blocks or inodes in the first byte.
 387                  * If there is any marked bit, this function returns 0.
 388                  */
 389                 if (first_bit & ADDR[start_byte])
 390                         return 0;
 391                 else if (len <= 8 - start_bit)
 392                         return 1;
 393
 394                 start_byte++;
 395                 len_bit = (len - mark_count) % 8;
 396                 len_byte = (len - mark_count) >> 3;
 397         }
 398
 399         /*
 400          * The compared start block number or start inode number is
 401          * the first bit in a byte.
 402          */
 403         if (len_bit != 0) {
 404                 /*
 405                  * The compared end block number or end inode number is
 406                  * not the last bit in a byte.
 407                  */
 408                 for (mark_bit = len_bit - 1; mark_bit >= 0; mark_bit--)
 409                         last_bit |= 1 << mark_bit;
 410
 411                 /*
 412                  * Compare blocks or inodes in the last byte.
 413                  * If there is any marked bit, this function returns 0.
 414                  */
 415                 if (last_bit & ADDR[start_byte + len_byte])
 416                         return 0;
 417                 else if (len_byte == 0)
 418                         return 1;
 419         }
 420
 421         /* Check whether all bytes are 0 */
 422         return mem_is_zero(ADDR + start_byte, len_byte);
 423 }
 424
 425 int ext2fs_test_block_bitmap_range(ext2fs_block_bitmap bitmap,
 426                                    blk_t block, int num)
 427 {
 428         EXT2_CHECK_MAGIC(bitmap, EXT2_ET_MAGIC_BLOCK_BITMAP);
 429         if ((block < bitmap->start) || (block+num-1 > bitmap->real_end)) {
 430                 ext2fs_warn_bitmap(EXT2_ET_BAD_BLOCK_TEST,
 431                                    block, bitmap->description);
 432                 return 0;
 433         }
 434         return ext2fs_test_clear_generic_bitmap_range((ext2fs_generic_bitmap)
 435                                                       bitmap, block, num);
 436 }
 437
 438 int ext2fs_test_inode_bitmap_range(ext2fs_inode_bitmap bitmap,
 439                                    ino_t inode, int num)
 440 {
 441         EXT2_CHECK_MAGIC(bitmap, EXT2_ET_MAGIC_INODE_BITMAP);
 442         if ((inode < bitmap->start) || (inode+num-1 > bitmap->real_end)) {
 443                 ext2fs_warn_bitmap(EXT2_ET_BAD_INODE_TEST,
 444                                    inode, bitmap->description);
 445                 return 0;
 446         }
 447         return ext2fs_test_clear_generic_bitmap_range((ext2fs_generic_bitmap)
 448                                                       bitmap, inode, num);
 449 }
 450
 451 void ext2fs_mark_block_bitmap_range(ext2fs_block_bitmap bitmap,
 452                                     blk_t block, int num)
 453 {
 454         int     i;
 455
 456         if ((block < bitmap->start) || (block+num-1 > bitmap->end)) {
 457                 ext2fs_warn_bitmap(EXT2_ET_BAD_BLOCK_MARK, block,
 458                                    bitmap->description);
 459                 return;
 460         }
 461         for (i=0; i < num; i++)
 462                 ext2fs_fast_set_bit(block + i - bitmap->start, bitmap->bitmap);
 463 }
 464
 465 void ext2fs_unmark_block_bitmap_range(ext2fs_block_bitmap bitmap,
 466                                                blk_t block, int num)
 467 {
 468         int     i;
 469
 470         if ((block < bitmap->start) || (block+num-1 > bitmap->end)) {
 471                 ext2fs_warn_bitmap(EXT2_ET_BAD_BLOCK_UNMARK, block,
 472                                    bitmap->description);
 473                 return;
 474         }
 475         for (i=0; i < num; i++)
 476                 ext2fs_fast_clear_bit(block + i - bitmap->start,
 477                                       bitmap->bitmap);
 478 }