fs/fat/fat.h

   1 #ifndef _FAT_H
   2 #define _FAT_H
   3
   4 #include <linux/buffer_head.h>
   5 #include <linux/string.h>
   6 #include <linux/nls.h>
   7 #include <linux/fs.h>
   8 #include <linux/mutex.h>
   9 #include <linux/msdos_fs.h>
  10
  11 /*
  12  * vfat shortname flags
  13  */
  14 #define VFAT_SFN_DISPLAY_LOWER  0x0001 /* convert to lowercase for display */
  15 #define VFAT_SFN_DISPLAY_WIN95  0x0002 /* emulate win95 rule for display */
  16 #define VFAT_SFN_DISPLAY_WINNT  0x0004 /* emulate winnt rule for display */
  17 #define VFAT_SFN_CREATE_WIN95   0x0100 /* emulate win95 rule for create */
  18 #define VFAT_SFN_CREATE_WINNT   0x0200 /* emulate winnt rule for create */
  19
  20 struct fat_mount_options {
  21         uid_t fs_uid;
  22         gid_t fs_gid;
  23         unsigned short fs_fmask;
  24         unsigned short fs_dmask;
  25         unsigned short codepage;  /* Codepage for shortname conversions */
  26         char *iocharset;          /* Charset used for filename input/display */
  27         unsigned short shortname; /* flags for shortname display/create rule */
  28         unsigned char name_check; /* r = relaxed, n = normal, s = strict */
  29         unsigned short allow_utime;/* permission for setting the [am]time */
  30         unsigned quiet:1,         /* set = fake successful chmods and chowns */
  31                  showexec:1,      /* set = only set x bit for com/exe/bat */
  32                  sys_immutable:1, /* set = system files are immutable */
  33                  dotsOK:1,        /* set = hidden and system files are named '.filename' */
  34                  isvfat:1,        /* 0=no vfat long filename support, 1=vfat support */
  35                  utf8:1,          /* Use of UTF-8 character set (Default) */
  36                  unicode_xlate:1, /* create escape sequences for unhandled Unicode */
  37                  numtail:1,       /* Does first alias have a numeric '~1' type tail? */
  38                  flush:1,         /* write things quickly */
  39                  nocase:1,        /* Does this need case conversion? 0=need case conversion*/
  40                  usefree:1,       /* Use free_clusters for FAT32 */
  41                  tz_utc:1,        /* Filesystem timestamps are in UTC */
  42                  rodir:1;         /* allow ATTR_RO for directory */
  43 };
  44
  45 #define FAT_HASH_BITS   8
  46 #define FAT_HASH_SIZE   (1UL << FAT_HASH_BITS)
  47
  48 /*
  49  * MS-DOS file system in-core superblock data
  50  */
  51 struct msdos_sb_info {
  52         unsigned short sec_per_clus; /* sectors/cluster */
  53         unsigned short cluster_bits; /* log2(cluster_size) */
  54         unsigned int cluster_size;   /* cluster size */
  55         unsigned char fats,fat_bits; /* number of FATs, FAT bits (12 or 16) */
  56         unsigned short fat_start;
  57         unsigned long fat_length;    /* FAT start & length (sec.) */
  58         unsigned long dir_start;
  59         unsigned short dir_entries;  /* root dir start & entries */
  60         unsigned long data_start;    /* first data sector */
  61         unsigned long max_cluster;   /* maximum cluster number */
  62         unsigned long root_cluster;  /* first cluster of the root directory */
  63         unsigned long fsinfo_sector; /* sector number of FAT32 fsinfo */
  64         struct mutex fat_lock;
  65         unsigned int prev_free;      /* previously allocated cluster number */
  66         unsigned int free_clusters;  /* -1 if undefined */
  67         unsigned int free_clus_valid; /* is free_clusters valid? */
  68         struct fat_mount_options options;
  69         struct nls_table *nls_disk;  /* Codepage used on disk */
  70         struct nls_table *nls_io;    /* Charset used for input and display */
  71         const void *dir_ops;                 /* Opaque; default directory operations */
  72         int dir_per_block;           /* dir entries per block */
  73         int dir_per_block_bits;      /* log2(dir_per_block) */
  74
  75         int fatent_shift;
  76         struct fatent_operations *fatent_ops;
  77         struct inode *fat_inode;
  78
  79         spinlock_t inode_hash_lock;
  80         struct hlist_head inode_hashtable[FAT_HASH_SIZE];
  81 };
  82
  83 #define FAT_CACHE_VALID 0       /* special case for valid cache */
  84
  85 /*
  86  * MS-DOS file system inode data in memory
  87  */
  88 struct msdos_inode_info {
  89         spinlock_t cache_lru_lock;
  90         struct list_head cache_lru;
  91         int nr_caches;
  92         /* for avoiding the race between fat_free() and fat_get_cluster() */
  93         unsigned int cache_valid_id;
  94
  95         /* NOTE: mmu_private is 64bits, so must hold ->i_mutex to access */
  96         loff_t mmu_private;     /* physically allocated size */
  97
  98         int i_start;            /* first cluster or 0 */
  99         int i_logstart;         /* logical first cluster */
 100         int i_attrs;            /* unused attribute bits */
 101         loff_t i_pos;           /* on-disk position of directory entry or 0 */
 102         struct hlist_node i_fat_hash;   /* hash by i_location */
 103         struct inode vfs_inode;
 104 };
 105
 106 struct fat_slot_info {
 107         loff_t i_pos;           /* on-disk position of directory entry */
 108         loff_t slot_off;        /* offset for slot or de start */
 109         int nr_slots;           /* number of slots + 1(de) in filename */
 110         struct msdos_dir_entry *de;
 111         struct buffer_head *bh;
 112 };
 113
 114 static inline struct msdos_sb_info *MSDOS_SB(struct super_block *sb)
 115 {
 116         return sb->s_fs_info;
 117 }
 118
 119 static inline struct msdos_inode_info *MSDOS_I(struct inode *inode)
 120 {
 121         return container_of(inode, struct msdos_inode_info, vfs_inode);
 122 }
 123
 124 /*
 125  * If ->i_mode can't hold S_IWUGO (i.e. ATTR_RO), we use ->i_attrs to
 126  * save ATTR_RO instead of ->i_mode.
 127  *
 128  * If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
 129  * bit, it's just used as flag for app.
 130  */
 131 static inline int fat_mode_can_hold_ro(struct inode *inode)
 132 {
 133         struct msdos_sb_info *sbi = MSDOS_SB(inode->i_sb);
 134         mode_t mask;
 135
 136         if (S_ISDIR(inode->i_mode)) {
 137                 if (!sbi->options.rodir)
 138                         return 0;
 139                 mask = ~sbi->options.fs_dmask;
 140         } else
 141                 mask = ~sbi->options.fs_fmask;
 142
 143         if (!(mask & S_IWUGO))
 144                 return 0;
 145         return 1;
 146 }
 147
 148 /* Convert attribute bits and a mask to the UNIX mode. */
 149 static inline mode_t fat_make_mode(struct msdos_sb_info *sbi,
 150                                    u8 attrs, mode_t mode)
 151 {
 152         if (attrs & ATTR_RO && !((attrs & ATTR_DIR) && !sbi->options.rodir))
 153                 mode &= ~S_IWUGO;
 154
 155         if (attrs & ATTR_DIR)
 156                 return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
 157         else
 158                 return (mode & ~sbi->options.fs_fmask) | S_IFREG;
 159 }
 160
 161 /* Return the FAT attribute byte for this inode */
 162 static inline u8 fat_make_attrs(struct inode *inode)
 163 {
 164         u8 attrs = MSDOS_I(inode)->i_attrs;
 165         if (S_ISDIR(inode->i_mode))
 166                 attrs |= ATTR_DIR;
 167         if (fat_mode_can_hold_ro(inode) && !(inode->i_mode & S_IWUGO))
 168                 attrs |= ATTR_RO;
 169         return attrs;
 170 }
 171
 172 static inline void fat_save_attrs(struct inode *inode, u8 attrs)
 173 {
 174         if (fat_mode_can_hold_ro(inode))
 175                 MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
 176         else
 177                 MSDOS_I(inode)->i_attrs = attrs & (ATTR_UNUSED | ATTR_RO);
 178 }
 179
 180 static inline unsigned char fat_checksum(const __u8 *name)
 181 {
 182         unsigned char s = name[0];
 183         s = (s<<7) + (s>>1) + name[1];  s = (s<<7) + (s>>1) + name[2];
 184         s = (s<<7) + (s>>1) + name[3];  s = (s<<7) + (s>>1) + name[4];
 185         s = (s<<7) + (s>>1) + name[5];  s = (s<<7) + (s>>1) + name[6];
 186         s = (s<<7) + (s>>1) + name[7];  s = (s<<7) + (s>>1) + name[8];
 187         s = (s<<7) + (s>>1) + name[9];  s = (s<<7) + (s>>1) + name[10];
 188         return s;
 189 }
 190
 191 static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
 192 {
 193         return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
 194                 + sbi->data_start;
 195 }
 196
 197 static inline void fat16_towchar(wchar_t *dst, const __u8 *src, size_t len)
 198 {
 199 #ifdef __BIG_ENDIAN
 200         while (len--) {
 201                 *dst++ = src[0] | (src[1] << 8);
 202                 src += 2;
 203         }
 204 #else
 205         memcpy(dst, src, len * 2);
 206 #endif
 207 }
 208
 209 static inline void fatwchar_to16(__u8 *dst, const wchar_t *src, size_t len)
 210 {
 211 #ifdef __BIG_ENDIAN
 212         while (len--) {
 213                 dst[0] = *src & 0x00FF;
 214                 dst[1] = (*src & 0xFF00) >> 8;
 215                 dst += 2;
 216                 src++;
 217         }
 218 #else
 219         memcpy(dst, src, len * 2);
 220 #endif
 221 }
 222
 223 /* fat/cache.c */
 224 extern void fat_cache_inval_inode(struct inode *inode);
 225 extern int fat_get_cluster(struct inode *inode, int cluster,
 226                            int *fclus, int *dclus);
 227 extern int fat_bmap(struct inode *inode, sector_t sector, sector_t *phys,
 228                     unsigned long *mapped_blocks, int create);
 229
 230 /* fat/dir.c */
 231 extern const struct file_operations fat_dir_operations;
 232 extern int fat_search_long(struct inode *inode, const unsigned char *name,
 233                            int name_len, struct fat_slot_info *sinfo);
 234 extern int fat_dir_empty(struct inode *dir);
 235 extern int fat_subdirs(struct inode *dir);
 236 extern int fat_scan(struct inode *dir, const unsigned char *name,
 237                     struct fat_slot_info *sinfo);
 238 extern int fat_get_dotdot_entry(struct inode *dir, struct buffer_head **bh,
 239                                 struct msdos_dir_entry **de, loff_t *i_pos);
 240 extern int fat_alloc_new_dir(struct inode *dir, struct timespec *ts);
 241 extern int fat_add_entries(struct inode *dir, void *slots, int nr_slots,
 242                            struct fat_slot_info *sinfo);
 243 extern int fat_remove_entries(struct inode *dir, struct fat_slot_info *sinfo);
 244
 245 /* fat/fatent.c */
 246 struct fat_entry {
 247         int entry;
 248         union {
 249                 u8 *ent12_p[2];
 250                 __le16 *ent16_p;
 251                 __le32 *ent32_p;
 252         } u;
 253         int nr_bhs;
 254         struct buffer_head *bhs[2];
 255         struct inode *fat_inode;
 256 };
 257
 258 static inline void fatent_init(struct fat_entry *fatent)
 259 {
 260         fatent->nr_bhs = 0;
 261         fatent->entry = 0;
 262         fatent->u.ent32_p = NULL;
 263         fatent->bhs[0] = fatent->bhs[1] = NULL;
 264         fatent->fat_inode = NULL;
 265 }
 266
 267 static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
 268 {
 269         fatent->entry = entry;
 270         fatent->u.ent32_p = NULL;
 271 }
 272
 273 static inline void fatent_brelse(struct fat_entry *fatent)
 274 {
 275         int i;
 276         fatent->u.ent32_p = NULL;
 277         for (i = 0; i < fatent->nr_bhs; i++)
 278                 brelse(fatent->bhs[i]);
 279         fatent->nr_bhs = 0;
 280         fatent->bhs[0] = fatent->bhs[1] = NULL;
 281         fatent->fat_inode = NULL;
 282 }
 283
 284 extern void fat_ent_access_init(struct super_block *sb);
 285 extern int fat_ent_read(struct inode *inode, struct fat_entry *fatent,
 286                         int entry);
 287 extern int fat_ent_write(struct inode *inode, struct fat_entry *fatent,
 288                          int new, int wait);
 289 extern int fat_alloc_clusters(struct inode *inode, int *cluster,
 290                               int nr_cluster);
 291 extern int fat_free_clusters(struct inode *inode, int cluster);
 292 extern int fat_count_free_clusters(struct super_block *sb);
 293
 294 /* fat/file.c */
 295 extern int fat_generic_ioctl(struct inode *inode, struct file *filp,
 296                              unsigned int cmd, unsigned long arg);
 297 extern const struct file_operations fat_file_operations;
 298 extern const struct inode_operations fat_file_inode_operations;
 299 extern int fat_setattr(struct dentry * dentry, struct iattr * attr);
 300 extern void fat_truncate(struct inode *inode);
 301 extern int fat_getattr(struct vfsmount *mnt, struct dentry *dentry,
 302                        struct kstat *stat);
 303 extern int fat_file_fsync(struct file *file, struct dentry *dentry,
 304                           int datasync);
 305
 306 /* fat/inode.c */
 307 extern void fat_attach(struct inode *inode, loff_t i_pos);
 308 extern void fat_detach(struct inode *inode);
 309 extern struct inode *fat_iget(struct super_block *sb, loff_t i_pos);
 310 extern struct inode *fat_build_inode(struct super_block *sb,
 311                         struct msdos_dir_entry *de, loff_t i_pos);
 312 extern int fat_sync_inode(struct inode *inode);
 313 extern int fat_fill_super(struct super_block *sb, void *data, int silent,
 314                         const struct inode_operations *fs_dir_inode_ops, int isvfat);
 315
 316 extern int fat_flush_inodes(struct super_block *sb, struct inode *i1,
 317                             struct inode *i2);
 318 /* fat/misc.c */
 319 extern void fat_fs_panic(struct super_block *s, const char *fmt, ...)
 320         __attribute__ ((format (printf, 2, 3))) __cold;
 321 extern void fat_clusters_flush(struct super_block *sb);
 322 extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
 323 extern void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec *ts,
 324                               __le16 __time, __le16 __date, u8 time_cs);
 325 extern void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec *ts,
 326                               __le16 *time, __le16 *date, u8 *time_cs);
 327 extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);
 328
 329 int fat_cache_init(void);
 330 void fat_cache_destroy(void);
 331
 332 /* helper for printk */
 333 typedef unsigned long long      llu;
 334
 335 #endif /* !_FAT_H */