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 };
  43
  44 #define FAT_HASH_BITS   8
  45 #define FAT_HASH_SIZE   (1UL << FAT_HASH_BITS)
  46
  47 /*
  48  * MS-DOS file system in-core superblock data
  49  */
  50 struct msdos_sb_info {
  51         unsigned short sec_per_clus; /* sectors/cluster */
  52         unsigned short cluster_bits; /* log2(cluster_size) */
  53         unsigned int cluster_size;   /* cluster size */
  54         unsigned char fats,fat_bits; /* number of FATs, FAT bits (12 or 16) */
  55         unsigned short fat_start;
  56         unsigned long fat_length;    /* FAT start & length (sec.) */
  57         unsigned long dir_start;
  58         unsigned short dir_entries;  /* root dir start & entries */
  59         unsigned long data_start;    /* first data sector */
  60         unsigned long max_cluster;   /* maximum cluster number */
  61         unsigned long root_cluster;  /* first cluster of the root directory */
  62         unsigned long fsinfo_sector; /* sector number of FAT32 fsinfo */
  63         struct mutex fat_lock;
  64         unsigned int prev_free;      /* previously allocated cluster number */
  65         unsigned int free_clusters;  /* -1 if undefined */
  66         unsigned int free_clus_valid; /* is free_clusters valid? */
  67         struct fat_mount_options options;
  68         struct nls_table *nls_disk;  /* Codepage used on disk */
  69         struct nls_table *nls_io;    /* Charset used for input and display */
  70         const void *dir_ops;                 /* Opaque; default directory operations */
  71         int dir_per_block;           /* dir entries per block */
  72         int dir_per_block_bits;      /* log2(dir_per_block) */
  73
  74         int fatent_shift;
  75         struct fatent_operations *fatent_ops;
  76
  77         spinlock_t inode_hash_lock;
  78         struct hlist_head inode_hashtable[FAT_HASH_SIZE];
  79 };
  80
  81 #define FAT_CACHE_VALID 0       /* special case for valid cache */
  82
  83 /*
  84  * MS-DOS file system inode data in memory
  85  */
  86 struct msdos_inode_info {
  87         spinlock_t cache_lru_lock;
  88         struct list_head cache_lru;
  89         int nr_caches;
  90         /* for avoiding the race between fat_free() and fat_get_cluster() */
  91         unsigned int cache_valid_id;
  92
  93         loff_t mmu_private;
  94         int i_start;            /* first cluster or 0 */
  95         int i_logstart;         /* logical first cluster */
  96         int i_attrs;            /* unused attribute bits */
  97         loff_t i_pos;           /* on-disk position of directory entry or 0 */
  98         struct hlist_node i_fat_hash;   /* hash by i_location */
  99         struct inode vfs_inode;
 100 };
 101
 102 struct fat_slot_info {
 103         loff_t i_pos;           /* on-disk position of directory entry */
 104         loff_t slot_off;        /* offset for slot or de start */
 105         int nr_slots;           /* number of slots + 1(de) in filename */
 106         struct msdos_dir_entry *de;
 107         struct buffer_head *bh;
 108 };
 109
 110 static inline struct msdos_sb_info *MSDOS_SB(struct super_block *sb)
 111 {
 112         return sb->s_fs_info;
 113 }
 114
 115 static inline struct msdos_inode_info *MSDOS_I(struct inode *inode)
 116 {
 117         return container_of(inode, struct msdos_inode_info, vfs_inode);
 118 }
 119
 120 /* Convert attribute bits and a mask to the UNIX mode. */
 121 static inline mode_t fat_make_mode(struct msdos_sb_info *sbi,
 122                                    u8 attrs, mode_t mode)
 123 {
 124         if (attrs & ATTR_RO)
 125                 mode &= ~S_IWUGO;
 126
 127         if (attrs & ATTR_DIR)
 128                 return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
 129         else
 130                 return (mode & ~sbi->options.fs_fmask) | S_IFREG;
 131 }
 132
 133 /* Return the FAT attribute byte for this inode */
 134 static inline u8 fat_make_attrs(struct inode *inode)
 135 {
 136         return ((inode->i_mode & S_IWUGO) ? ATTR_NONE : ATTR_RO) |
 137                 (S_ISDIR(inode->i_mode) ? ATTR_DIR : ATTR_NONE) |
 138                 MSDOS_I(inode)->i_attrs;
 139 }
 140
 141 static inline void fat_save_attrs(struct inode *inode, u8 attrs)
 142 {
 143         MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
 144 }
 145
 146 static inline unsigned char fat_checksum(const __u8 *name)
 147 {
 148         unsigned char s = name[0];
 149         s = (s<<7) + (s>>1) + name[1];  s = (s<<7) + (s>>1) + name[2];
 150         s = (s<<7) + (s>>1) + name[3];  s = (s<<7) + (s>>1) + name[4];
 151         s = (s<<7) + (s>>1) + name[5];  s = (s<<7) + (s>>1) + name[6];
 152         s = (s<<7) + (s>>1) + name[7];  s = (s<<7) + (s>>1) + name[8];
 153         s = (s<<7) + (s>>1) + name[9];  s = (s<<7) + (s>>1) + name[10];
 154         return s;
 155 }
 156
 157 static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
 158 {
 159         return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
 160                 + sbi->data_start;
 161 }
 162
 163 static inline void fat16_towchar(wchar_t *dst, const __u8 *src, size_t len)
 164 {
 165 #ifdef __BIG_ENDIAN
 166         while (len--) {
 167                 *dst++ = src[0] | (src[1] << 8);
 168                 src += 2;
 169         }
 170 #else
 171         memcpy(dst, src, len * 2);
 172 #endif
 173 }
 174
 175 static inline void fatwchar_to16(__u8 *dst, const wchar_t *src, size_t len)
 176 {
 177 #ifdef __BIG_ENDIAN
 178         while (len--) {
 179                 dst[0] = *src & 0x00FF;
 180                 dst[1] = (*src & 0xFF00) >> 8;
 181                 dst += 2;
 182                 src++;
 183         }
 184 #else
 185         memcpy(dst, src, len * 2);
 186 #endif
 187 }
 188
 189 /* fat/cache.c */
 190 extern void fat_cache_inval_inode(struct inode *inode);
 191 extern int fat_get_cluster(struct inode *inode, int cluster,
 192                            int *fclus, int *dclus);
 193 extern int fat_bmap(struct inode *inode, sector_t sector, sector_t *phys,
 194                     unsigned long *mapped_blocks);
 195
 196 /* fat/dir.c */
 197 extern const struct file_operations fat_dir_operations;
 198 extern int fat_search_long(struct inode *inode, const unsigned char *name,
 199                            int name_len, struct fat_slot_info *sinfo);
 200 extern int fat_dir_empty(struct inode *dir);
 201 extern int fat_subdirs(struct inode *dir);
 202 extern int fat_scan(struct inode *dir, const unsigned char *name,
 203                     struct fat_slot_info *sinfo);
 204 extern int fat_get_dotdot_entry(struct inode *dir, struct buffer_head **bh,
 205                                 struct msdos_dir_entry **de, loff_t *i_pos);
 206 extern int fat_alloc_new_dir(struct inode *dir, struct timespec *ts);
 207 extern int fat_add_entries(struct inode *dir, void *slots, int nr_slots,
 208                            struct fat_slot_info *sinfo);
 209 extern int fat_remove_entries(struct inode *dir, struct fat_slot_info *sinfo);
 210
 211 /* fat/fatent.c */
 212 struct fat_entry {
 213         int entry;
 214         union {
 215                 u8 *ent12_p[2];
 216                 __le16 *ent16_p;
 217                 __le32 *ent32_p;
 218         } u;
 219         int nr_bhs;
 220         struct buffer_head *bhs[2];
 221 };
 222
 223 static inline void fatent_init(struct fat_entry *fatent)
 224 {
 225         fatent->nr_bhs = 0;
 226         fatent->entry = 0;
 227         fatent->u.ent32_p = NULL;
 228         fatent->bhs[0] = fatent->bhs[1] = NULL;
 229 }
 230
 231 static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
 232 {
 233         fatent->entry = entry;
 234         fatent->u.ent32_p = NULL;
 235 }
 236
 237 static inline void fatent_brelse(struct fat_entry *fatent)
 238 {
 239         int i;
 240         fatent->u.ent32_p = NULL;
 241         for (i = 0; i < fatent->nr_bhs; i++)
 242                 brelse(fatent->bhs[i]);
 243         fatent->nr_bhs = 0;
 244         fatent->bhs[0] = fatent->bhs[1] = NULL;
 245 }
 246
 247 extern void fat_ent_access_init(struct super_block *sb);
 248 extern int fat_ent_read(struct inode *inode, struct fat_entry *fatent,
 249                         int entry);
 250 extern int fat_ent_write(struct inode *inode, struct fat_entry *fatent,
 251                          int new, int wait);
 252 extern int fat_alloc_clusters(struct inode *inode, int *cluster,
 253                               int nr_cluster);
 254 extern int fat_free_clusters(struct inode *inode, int cluster);
 255 extern int fat_count_free_clusters(struct super_block *sb);
 256
 257 /* fat/file.c */
 258 extern int fat_generic_ioctl(struct inode *inode, struct file *filp,
 259                              unsigned int cmd, unsigned long arg);
 260 extern const struct file_operations fat_file_operations;
 261 extern const struct inode_operations fat_file_inode_operations;
 262 extern int fat_setattr(struct dentry * dentry, struct iattr * attr);
 263 extern void fat_truncate(struct inode *inode);
 264 extern int fat_getattr(struct vfsmount *mnt, struct dentry *dentry,
 265                        struct kstat *stat);
 266
 267 /* fat/inode.c */
 268 extern void fat_attach(struct inode *inode, loff_t i_pos);
 269 extern void fat_detach(struct inode *inode);
 270 extern struct inode *fat_iget(struct super_block *sb, loff_t i_pos);
 271 extern struct inode *fat_build_inode(struct super_block *sb,
 272                         struct msdos_dir_entry *de, loff_t i_pos);
 273 extern int fat_sync_inode(struct inode *inode);
 274 extern int fat_fill_super(struct super_block *sb, void *data, int silent,
 275                         const struct inode_operations *fs_dir_inode_ops, int isvfat);
 276
 277 extern int fat_flush_inodes(struct super_block *sb, struct inode *i1,
 278                             struct inode *i2);
 279 /* fat/misc.c */
 280 extern void fat_fs_panic(struct super_block *s, const char *fmt, ...);
 281 extern void fat_clusters_flush(struct super_block *sb);
 282 extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
 283 extern void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec *ts,
 284                               __le16 __time, __le16 __date, u8 time_cs);
 285 extern void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec *ts,
 286                               __le16 *time, __le16 *date, u8 *time_cs);
 287 extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);
 288
 289 int fat_cache_init(void);
 290 void fat_cache_destroy(void);
 291
 292 #endif /* !_FAT_H */