fs/ufs/util.h

   1 /*
   2  *  linux/fs/ufs/util.h
   3  *
   4  * Copyright (C) 1998
   5  * Daniel Pirkl <daniel.pirkl@email.cz>
   6  * Charles University, Faculty of Mathematics and Physics
   7  */
   8
   9 #include <linux/buffer_head.h>
  10 #include <linux/fs.h>
  11 #include "swab.h"
  12
  13
  14 /*
  15  * some useful macros
  16  */
  17 #define in_range(b,first,len)   ((b)>=(first)&&(b)<(first)+(len))
  18
  19 /*
  20  * macros used for retyping
  21  */
  22 #define UCPI_UBH ((struct ufs_buffer_head *)ucpi)
  23 #define USPI_UBH ((struct ufs_buffer_head *)uspi)
  24
  25
  26
  27 /*
  28  * macros used for accessing structures
  29  */
  30 static inline s32
  31 ufs_get_fs_state(struct super_block *sb, struct ufs_super_block_first *usb1,
  32                  struct ufs_super_block_third *usb3)
  33 {
  34         switch (UFS_SB(sb)->s_flags & UFS_ST_MASK) {
  35         case UFS_ST_SUN:
  36                 return fs32_to_cpu(sb, usb3->fs_u2.fs_sun.fs_state);
  37         case UFS_ST_SUNx86:
  38                 return fs32_to_cpu(sb, usb1->fs_u1.fs_sunx86.fs_state);
  39         case UFS_ST_44BSD:
  40         default:
  41                 return fs32_to_cpu(sb, usb3->fs_u2.fs_44.fs_state);
  42         }
  43 }
  44
  45 static inline void
  46 ufs_set_fs_state(struct super_block *sb, struct ufs_super_block_first *usb1,
  47                  struct ufs_super_block_third *usb3, s32 value)
  48 {
  49         switch (UFS_SB(sb)->s_flags & UFS_ST_MASK) {
  50         case UFS_ST_SUN:
  51                 usb3->fs_u2.fs_sun.fs_state = cpu_to_fs32(sb, value);
  52                 break;
  53         case UFS_ST_SUNx86:
  54                 usb1->fs_u1.fs_sunx86.fs_state = cpu_to_fs32(sb, value);
  55                 break;
  56         case UFS_ST_44BSD:
  57                 usb3->fs_u2.fs_44.fs_state = cpu_to_fs32(sb, value);
  58                 break;
  59         }
  60 }
  61
  62 static inline u32
  63 ufs_get_fs_npsect(struct super_block *sb, struct ufs_super_block_first *usb1,
  64                   struct ufs_super_block_third *usb3)
  65 {
  66         if ((UFS_SB(sb)->s_flags & UFS_ST_MASK) == UFS_ST_SUNx86)
  67                 return fs32_to_cpu(sb, usb3->fs_u2.fs_sunx86.fs_npsect);
  68         else
  69                 return fs32_to_cpu(sb, usb1->fs_u1.fs_sun.fs_npsect);
  70 }
  71
  72 static inline u64
  73 ufs_get_fs_qbmask(struct super_block *sb, struct ufs_super_block_third *usb3)
  74 {
  75         u64 tmp;
  76
  77         switch (UFS_SB(sb)->s_flags & UFS_ST_MASK) {
  78         case UFS_ST_SUN:
  79                 ((u32 *)&tmp)[0] = usb3->fs_u2.fs_sun.fs_qbmask[0];
  80                 ((u32 *)&tmp)[1] = usb3->fs_u2.fs_sun.fs_qbmask[1];
  81                 break;
  82         case UFS_ST_SUNx86:
  83                 ((u32 *)&tmp)[0] = usb3->fs_u2.fs_sunx86.fs_qbmask[0];
  84                 ((u32 *)&tmp)[1] = usb3->fs_u2.fs_sunx86.fs_qbmask[1];
  85                 break;
  86         case UFS_ST_44BSD:
  87                 ((u32 *)&tmp)[0] = usb3->fs_u2.fs_44.fs_qbmask[0];
  88                 ((u32 *)&tmp)[1] = usb3->fs_u2.fs_44.fs_qbmask[1];
  89                 break;
  90         }
  91
  92         return fs64_to_cpu(sb, tmp);
  93 }
  94
  95 static inline u64
  96 ufs_get_fs_qfmask(struct super_block *sb, struct ufs_super_block_third *usb3)
  97 {
  98         u64 tmp;
  99
 100         switch (UFS_SB(sb)->s_flags & UFS_ST_MASK) {
 101         case UFS_ST_SUN:
 102                 ((u32 *)&tmp)[0] = usb3->fs_u2.fs_sun.fs_qfmask[0];
 103                 ((u32 *)&tmp)[1] = usb3->fs_u2.fs_sun.fs_qfmask[1];
 104                 break;
 105         case UFS_ST_SUNx86:
 106                 ((u32 *)&tmp)[0] = usb3->fs_u2.fs_sunx86.fs_qfmask[0];
 107                 ((u32 *)&tmp)[1] = usb3->fs_u2.fs_sunx86.fs_qfmask[1];
 108                 break;
 109         case UFS_ST_44BSD:
 110                 ((u32 *)&tmp)[0] = usb3->fs_u2.fs_44.fs_qfmask[0];
 111                 ((u32 *)&tmp)[1] = usb3->fs_u2.fs_44.fs_qfmask[1];
 112                 break;
 113         }
 114
 115         return fs64_to_cpu(sb, tmp);
 116 }
 117
 118 static inline u16
 119 ufs_get_de_namlen(struct super_block *sb, struct ufs_dir_entry *de)
 120 {
 121         if ((UFS_SB(sb)->s_flags & UFS_DE_MASK) == UFS_DE_OLD)
 122                 return fs16_to_cpu(sb, de->d_u.d_namlen);
 123         else
 124                 return de->d_u.d_44.d_namlen; /* XXX this seems wrong */
 125 }
 126
 127 static inline void
 128 ufs_set_de_namlen(struct super_block *sb, struct ufs_dir_entry *de, u16 value)
 129 {
 130         if ((UFS_SB(sb)->s_flags & UFS_DE_MASK) == UFS_DE_OLD)
 131                 de->d_u.d_namlen = cpu_to_fs16(sb, value);
 132         else
 133                 de->d_u.d_44.d_namlen = value; /* XXX this seems wrong */
 134 }
 135
 136 static inline void
 137 ufs_set_de_type(struct super_block *sb, struct ufs_dir_entry *de, int mode)
 138 {
 139         if ((UFS_SB(sb)->s_flags & UFS_DE_MASK) != UFS_DE_44BSD)
 140                 return;
 141
 142         /*
 143          * TODO turn this into a table lookup
 144          */
 145         switch (mode & S_IFMT) {
 146         case S_IFSOCK:
 147                 de->d_u.d_44.d_type = DT_SOCK;
 148                 break;
 149         case S_IFLNK:
 150                 de->d_u.d_44.d_type = DT_LNK;
 151                 break;
 152         case S_IFREG:
 153                 de->d_u.d_44.d_type = DT_REG;
 154                 break;
 155         case S_IFBLK:
 156                 de->d_u.d_44.d_type = DT_BLK;
 157                 break;
 158         case S_IFDIR:
 159                 de->d_u.d_44.d_type = DT_DIR;
 160                 break;
 161         case S_IFCHR:
 162                 de->d_u.d_44.d_type = DT_CHR;
 163                 break;
 164         case S_IFIFO:
 165                 de->d_u.d_44.d_type = DT_FIFO;
 166                 break;
 167         default:
 168                 de->d_u.d_44.d_type = DT_UNKNOWN;
 169         }
 170 }
 171
 172 static inline u32
 173 ufs_get_inode_uid(struct super_block *sb, struct ufs_inode *inode)
 174 {
 175         switch (UFS_SB(sb)->s_flags & UFS_UID_MASK) {
 176         case UFS_UID_EFT:
 177                 return fs32_to_cpu(sb, inode->ui_u3.ui_sun.ui_uid);
 178         case UFS_UID_44BSD:
 179                 return fs32_to_cpu(sb, inode->ui_u3.ui_44.ui_uid);
 180         default:
 181                 return fs16_to_cpu(sb, inode->ui_u1.oldids.ui_suid);
 182         }
 183 }
 184
 185 static inline void
 186 ufs_set_inode_uid(struct super_block *sb, struct ufs_inode *inode, u32 value)
 187 {
 188         switch (UFS_SB(sb)->s_flags & UFS_UID_MASK) {
 189         case UFS_UID_EFT:
 190                 inode->ui_u3.ui_sun.ui_uid = cpu_to_fs32(sb, value);
 191                 break;
 192         case UFS_UID_44BSD:
 193                 inode->ui_u3.ui_44.ui_uid = cpu_to_fs32(sb, value);
 194                 break;
 195         }
 196         inode->ui_u1.oldids.ui_suid = cpu_to_fs16(sb, value);
 197 }
 198
 199 static inline u32
 200 ufs_get_inode_gid(struct super_block *sb, struct ufs_inode *inode)
 201 {
 202         switch (UFS_SB(sb)->s_flags & UFS_UID_MASK) {
 203         case UFS_UID_EFT:
 204                 return fs32_to_cpu(sb, inode->ui_u3.ui_sun.ui_gid);
 205         case UFS_UID_44BSD:
 206                 return fs32_to_cpu(sb, inode->ui_u3.ui_44.ui_gid);
 207         default:
 208                 return fs16_to_cpu(sb, inode->ui_u1.oldids.ui_sgid);
 209         }
 210 }
 211
 212 static inline void
 213 ufs_set_inode_gid(struct super_block *sb, struct ufs_inode *inode, u32 value)
 214 {
 215         switch (UFS_SB(sb)->s_flags & UFS_UID_MASK) {
 216         case UFS_UID_EFT:
 217                 inode->ui_u3.ui_sun.ui_gid = cpu_to_fs32(sb, value);
 218                 break;
 219         case UFS_UID_44BSD:
 220                 inode->ui_u3.ui_44.ui_gid = cpu_to_fs32(sb, value);
 221                 break;
 222         }
 223         inode->ui_u1.oldids.ui_sgid =  cpu_to_fs16(sb, value);
 224 }
 225
 226
 227 /*
 228  * These functions manipulate ufs buffers
 229  */
 230 #define ubh_bread(sb,fragment,size) _ubh_bread_(uspi,sb,fragment,size)
 231 extern struct ufs_buffer_head * _ubh_bread_(struct ufs_sb_private_info *, struct super_block *, u64 , u64);
 232 extern struct ufs_buffer_head * ubh_bread_uspi(struct ufs_sb_private_info *, struct super_block *, u64, u64);
 233 extern void ubh_brelse (struct ufs_buffer_head *);
 234 extern void ubh_brelse_uspi (struct ufs_sb_private_info *);
 235 extern void ubh_mark_buffer_dirty (struct ufs_buffer_head *);
 236 extern void ubh_mark_buffer_uptodate (struct ufs_buffer_head *, int);
 237 extern void ubh_ll_rw_block (int, unsigned, struct ufs_buffer_head **);
 238 extern void ubh_wait_on_buffer (struct ufs_buffer_head *);
 239 extern unsigned ubh_max_bcount (struct ufs_buffer_head *);
 240 extern void ubh_bforget (struct ufs_buffer_head *);
 241 extern int  ubh_buffer_dirty (struct ufs_buffer_head *);
 242 #define ubh_ubhcpymem(mem,ubh,size) _ubh_ubhcpymem_(uspi,mem,ubh,size)
 243 extern void _ubh_ubhcpymem_(struct ufs_sb_private_info *, unsigned char *, struct ufs_buffer_head *, unsigned);
 244 #define ubh_memcpyubh(ubh,mem,size) _ubh_memcpyubh_(uspi,ubh,mem,size)
 245 extern void _ubh_memcpyubh_(struct ufs_sb_private_info *, struct ufs_buffer_head *, unsigned char *, unsigned);
 246
 247
 248
 249 /*
 250  * macros to get important structures from ufs_buffer_head
 251  */
 252 #define ubh_get_usb_first(ubh) \
 253         ((struct ufs_super_block_first *)((ubh)->bh[0]->b_data))
 254
 255 #define ubh_get_usb_second(ubh) \
 256         ((struct ufs_super_block_second *)(ubh)-> \
 257         bh[UFS_SECTOR_SIZE >> uspi->s_fshift]->b_data + (UFS_SECTOR_SIZE & ~uspi->s_fmask))
 258
 259 #define ubh_get_usb_third(ubh) \
 260         ((struct ufs_super_block_third *)((ubh)-> \
 261         bh[UFS_SECTOR_SIZE*2 >> uspi->s_fshift]->b_data + (UFS_SECTOR_SIZE*2 & ~uspi->s_fmask)))
 262
 263 #define ubh_get_ucg(ubh) \
 264         ((struct ufs_cylinder_group *)((ubh)->bh[0]->b_data))
 265
 266
 267 /*
 268  * Extract byte from ufs_buffer_head
 269  * Extract the bits for a block from a map inside ufs_buffer_head
 270  */
 271 #define ubh_get_addr8(ubh,begin) \
 272         ((u8*)(ubh)->bh[(begin) >> uspi->s_fshift]->b_data + \
 273         ((begin) & ~uspi->s_fmask))
 274
 275 #define ubh_get_addr16(ubh,begin) \
 276         (((u16*)((ubh)->bh[(begin) >> (uspi->s_fshift-1)]->b_data)) + \
 277         ((begin) & (uspi->fsize>>1) - 1)))
 278
 279 #define ubh_get_addr32(ubh,begin) \
 280         (((u32*)((ubh)->bh[(begin) >> (uspi->s_fshift-2)]->b_data)) + \
 281         ((begin) & ((uspi->s_fsize>>2) - 1)))
 282
 283 #define ubh_get_addr ubh_get_addr8
 284
 285 #define ubh_blkmap(ubh,begin,bit) \
 286         ((*ubh_get_addr(ubh, (begin) + ((bit) >> 3)) >> ((bit) & 7)) & (0xff >> (UFS_MAXFRAG - uspi->s_fpb)))
 287
 288
 289 /*
 290  * Macros for access to superblock array structures
 291  */
 292 #define ubh_postbl(ubh,cylno,i) \
 293         ((uspi->s_postblformat != UFS_DYNAMICPOSTBLFMT) \
 294         ? (*(__s16*)(ubh_get_addr(ubh, \
 295         (unsigned)(&((struct ufs_super_block *)0)->fs_opostbl) \
 296         + (((cylno) * 16 + (i)) << 1) ) )) \
 297         : (*(__s16*)(ubh_get_addr(ubh, \
 298         uspi->s_postbloff + (((cylno) * uspi->s_nrpos + (i)) << 1) ))))
 299
 300 #define ubh_rotbl(ubh,i) \
 301         ((uspi->s_postblformat != UFS_DYNAMICPOSTBLFMT) \
 302         ? (*(__u8*)(ubh_get_addr(ubh, \
 303         (unsigned)(&((struct ufs_super_block *)0)->fs_space) + (i)))) \
 304         : (*(__u8*)(ubh_get_addr(ubh, uspi->s_rotbloff + (i)))))
 305
 306 /*
 307  * Determine the number of available frags given a
 308  * percentage to hold in reserve.
 309  */
 310 #define ufs_freespace(usb, percentreserved) \
 311         (ufs_blkstofrags(fs32_to_cpu(sb, (usb)->fs_cstotal.cs_nbfree)) + \
 312         fs32_to_cpu(sb, (usb)->fs_cstotal.cs_nffree) - (uspi->s_dsize * (percentreserved) / 100))
 313
 314 /*
 315  * Macros to access cylinder group array structures
 316  */
 317 #define ubh_cg_blktot(ucpi,cylno) \
 318         (*((__u32*)ubh_get_addr(UCPI_UBH, (ucpi)->c_btotoff + ((cylno) << 2))))
 319
 320 #define ubh_cg_blks(ucpi,cylno,rpos) \
 321         (*((__u16*)ubh_get_addr(UCPI_UBH, \
 322         (ucpi)->c_boff + (((cylno) * uspi->s_nrpos + (rpos)) << 1 ))))
 323
 324 /*
 325  * Bitmap operations
 326  * These functions work like classical bitmap operations.
 327  * The difference is that we don't have the whole bitmap
 328  * in one contiguous chunk of memory, but in several buffers.
 329  * The parameters of each function are super_block, ufs_buffer_head and
 330  * position of the beginning of the bitmap.
 331  */
 332 #define ubh_setbit(ubh,begin,bit) \
 333         (*ubh_get_addr(ubh, (begin) + ((bit) >> 3)) |= (1 << ((bit) & 7)))
 334
 335 #define ubh_clrbit(ubh,begin,bit) \
 336         (*ubh_get_addr (ubh, (begin) + ((bit) >> 3)) &= ~(1 << ((bit) & 7)))
 337
 338 #define ubh_isset(ubh,begin,bit) \
 339         (*ubh_get_addr (ubh, (begin) + ((bit) >> 3)) & (1 << ((bit) & 7)))
 340
 341 #define ubh_isclr(ubh,begin,bit) (!ubh_isset(ubh,begin,bit))
 342
 343 #define ubh_find_first_zero_bit(ubh,begin,size) _ubh_find_next_zero_bit_(uspi,ubh,begin,size,0)
 344
 345 #define ubh_find_next_zero_bit(ubh,begin,size,offset) _ubh_find_next_zero_bit_(uspi,ubh,begin,size,offset)
 346 static inline unsigned _ubh_find_next_zero_bit_(
 347         struct ufs_sb_private_info * uspi, struct ufs_buffer_head * ubh,
 348         unsigned begin, unsigned size, unsigned offset)
 349 {
 350         unsigned base, count, pos;
 351
 352         size -= offset;
 353         begin <<= 3;
 354         offset += begin;
 355         base = offset >> uspi->s_bpfshift;
 356         offset &= uspi->s_bpfmask;
 357         for (;;) {
 358                 count = min_t(unsigned int, size + offset, uspi->s_bpf);
 359                 size -= count - offset;
 360                 pos = ext2_find_next_zero_bit (ubh->bh[base]->b_data, count, offset);
 361                 if (pos < count || !size)
 362                         break;
 363                 base++;
 364                 offset = 0;
 365         }
 366         return (base << uspi->s_bpfshift) + pos - begin;
 367 }
 368
 369 static inline unsigned find_last_zero_bit (unsigned char * bitmap,
 370         unsigned size, unsigned offset)
 371 {
 372         unsigned bit, i;
 373         unsigned char * mapp;
 374         unsigned char map;
 375
 376         mapp = bitmap + (size >> 3);
 377         map = *mapp--;
 378         bit = 1 << (size & 7);
 379         for (i = size; i > offset; i--) {
 380                 if ((map & bit) == 0)
 381                         break;
 382                 if ((i & 7) != 0) {
 383                         bit >>= 1;
 384                 } else {
 385                         map = *mapp--;
 386                         bit = 1 << 7;
 387                 }
 388         }
 389         return i;
 390 }
 391
 392 #define ubh_find_last_zero_bit(ubh,begin,size,offset) _ubh_find_last_zero_bit_(uspi,ubh,begin,size,offset)
 393 static inline unsigned _ubh_find_last_zero_bit_(
 394         struct ufs_sb_private_info * uspi, struct ufs_buffer_head * ubh,
 395         unsigned begin, unsigned start, unsigned end)
 396 {
 397         unsigned base, count, pos, size;
 398
 399         size = start - end;
 400         begin <<= 3;
 401         start += begin;
 402         base = start >> uspi->s_bpfshift;
 403         start &= uspi->s_bpfmask;
 404         for (;;) {
 405                 count = min_t(unsigned int,
 406                             size + (uspi->s_bpf - start), uspi->s_bpf)
 407                         - (uspi->s_bpf - start);
 408                 size -= count;
 409                 pos = find_last_zero_bit (ubh->bh[base]->b_data,
 410                         start, start - count);
 411                 if (pos > start - count || !size)
 412                         break;
 413                 base--;
 414                 start = uspi->s_bpf;
 415         }
 416         return (base << uspi->s_bpfshift) + pos - begin;
 417 }
 418
 419 #define ubh_isblockclear(ubh,begin,block) (!_ubh_isblockset_(uspi,ubh,begin,block))
 420
 421 #define ubh_isblockset(ubh,begin,block) _ubh_isblockset_(uspi,ubh,begin,block)
 422 static inline int _ubh_isblockset_(struct ufs_sb_private_info * uspi,
 423         struct ufs_buffer_head * ubh, unsigned begin, unsigned block)
 424 {
 425         switch (uspi->s_fpb) {
 426         case 8:
 427                 return (*ubh_get_addr (ubh, begin + block) == 0xff);
 428         case 4:
 429                 return (*ubh_get_addr (ubh, begin + (block >> 1)) == (0x0f << ((block & 0x01) << 2)));
 430         case 2:
 431                 return (*ubh_get_addr (ubh, begin + (block >> 2)) == (0x03 << ((block & 0x03) << 1)));
 432         case 1:
 433                 return (*ubh_get_addr (ubh, begin + (block >> 3)) == (0x01 << (block & 0x07)));
 434         }
 435         return 0;
 436 }
 437
 438 #define ubh_clrblock(ubh,begin,block) _ubh_clrblock_(uspi,ubh,begin,block)
 439 static inline void _ubh_clrblock_(struct ufs_sb_private_info * uspi,
 440         struct ufs_buffer_head * ubh, unsigned begin, unsigned block)
 441 {
 442         switch (uspi->s_fpb) {
 443         case 8:
 444                 *ubh_get_addr (ubh, begin + block) = 0x00;
 445                 return;
 446         case 4:
 447                 *ubh_get_addr (ubh, begin + (block >> 1)) &= ~(0x0f << ((block & 0x01) << 2));
 448                 return;
 449         case 2:
 450                 *ubh_get_addr (ubh, begin + (block >> 2)) &= ~(0x03 << ((block & 0x03) << 1));
 451                 return;
 452         case 1:
 453                 *ubh_get_addr (ubh, begin + (block >> 3)) &= ~(0x01 << ((block & 0x07)));
 454                 return;
 455         }
 456 }
 457
 458 #define ubh_setblock(ubh,begin,block) _ubh_setblock_(uspi,ubh,begin,block)
 459 static inline void _ubh_setblock_(struct ufs_sb_private_info * uspi,
 460         struct ufs_buffer_head * ubh, unsigned begin, unsigned block)
 461 {
 462         switch (uspi->s_fpb) {
 463         case 8:
 464                 *ubh_get_addr(ubh, begin + block) = 0xff;
 465                 return;
 466         case 4:
 467                 *ubh_get_addr(ubh, begin + (block >> 1)) |= (0x0f << ((block & 0x01) << 2));
 468                 return;
 469         case 2:
 470                 *ubh_get_addr(ubh, begin + (block >> 2)) |= (0x03 << ((block & 0x03) << 1));
 471                 return;
 472         case 1:
 473                 *ubh_get_addr(ubh, begin + (block >> 3)) |= (0x01 << ((block & 0x07)));
 474                 return;
 475         }
 476 }
 477
 478 static inline void ufs_fragacct (struct super_block * sb, unsigned blockmap,
 479         unsigned * fraglist, int cnt)
 480 {
 481         struct ufs_sb_private_info * uspi;
 482         unsigned fragsize, pos;
 483
 484         uspi = UFS_SB(sb)->s_uspi;
 485
 486         fragsize = 0;
 487         for (pos = 0; pos < uspi->s_fpb; pos++) {
 488                 if (blockmap & (1 << pos)) {
 489                         fragsize++;
 490                 }
 491                 else if (fragsize > 0) {
 492                         fs32_add(sb, &fraglist[fragsize], cnt);
 493                         fragsize = 0;
 494                 }
 495         }
 496         if (fragsize > 0 && fragsize < uspi->s_fpb)
 497                 fs32_add(sb, &fraglist[fragsize], cnt);
 498 }
 499
 500 #define ubh_scanc(ubh,begin,size,table,mask) _ubh_scanc_(uspi,ubh,begin,size,table,mask)
 501 static inline unsigned _ubh_scanc_(struct ufs_sb_private_info * uspi, struct ufs_buffer_head * ubh,
 502         unsigned begin, unsigned size, unsigned char * table, unsigned char mask)
 503 {
 504         unsigned rest, offset;
 505         unsigned char * cp;
 506
 507
 508         offset = begin & ~uspi->s_fmask;
 509         begin >>= uspi->s_fshift;
 510         for (;;) {
 511                 if ((offset + size) < uspi->s_fsize)
 512                         rest = size;
 513                 else
 514                         rest = uspi->s_fsize - offset;
 515                 size -= rest;
 516                 cp = ubh->bh[begin]->b_data + offset;
 517                 while ((table[*cp++] & mask) == 0 && --rest);
 518                 if (rest || !size)
 519                         break;
 520                 begin++;
 521                 offset = 0;
 522         }
 523         return (size + rest);
 524 }