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