rom/filesys/fat/fat_fs.h

   1 /*
   2  * fat-handler - FAT12/16/32 filesystem handler
   3  *
   4  * Copyright © 2006 Marek Szyprowski
   5  * Copyright © 2007-2015 The AROS Development Team
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the same terms as AROS itself.
   9  *
  10  * $Id$
  11  */
  12
  13 #ifndef FAT_HANDLER_H
  14 #define FAT_HANDLER_H
  15
  16 #define DEBUG_DIRENTRY      0
  17 #define DEBUG_FILE          0
  18 #define DEBUG_DUMP          0
  19 #define DEBUG_LOCK          0
  20 #define DEBUG_NAMES         0
  21 #define DEBUG_NOTIFY        0
  22 #define DEBUG_OPS           0
  23 #define DEBUG_PACKETS       0
  24 #define DEBUG_CACHESTATS    0
  25 #define DEBUG_MISC          0
  26
  27 #include <devices/trackdisk.h>
  28
  29 #include "fat_struct.h"
  30
  31 #include "cache.h"
  32
  33 /* filesystem structures */
  34
  35 #define ID_FAT_DISK 0x46415400UL
  36
  37 #define ID_FAT12_DISK 0x46415400UL
  38 #define ID_FAT16_DISK 0x46415401UL
  39 #define ID_FAT32_DISK 0x46415402UL
  40
  41 #define ACTION_VOLUME_ADD 16000
  42 #define ACTION_VOLUME_REMOVE 16001
  43
  44 #define DEF_POOL_SIZE 65536
  45 #define DEF_POOL_THRESHOLD DEF_POOL_SIZE
  46
  47
  48 /* a handle on something, file or directory */
  49 struct IOHandle
  50 {
  51     struct FSSuper      *sb;            /* filesystem data */
  52
  53     ULONG               first_cluster;  /* first cluster of this file */
  54     ULONG               cur_cluster;    /* cluster that the current sector is within */
  55
  56     ULONG               cluster_offset; /* cluster number of this cluster within the current file */
  57
  58     ULONG               first_sector;   /* first sector in the first cluster, for fat12/16 root dir */
  59     ULONG               cur_sector;     /* sector number our block is currently in */
  60
  61     ULONG               sector_offset;  /* current sector as an offset in the current cluster
  62                                            i.e. cur = sector(cur_cluster) + offset */
  63
  64     APTR block;         /* current block from the cache */
  65     UBYTE *data;        /* current data buffer (from cache) */
  66 };
  67
  68 /* a handle on a directory */
  69 struct DirHandle
  70 {
  71     struct IOHandle     ioh;
  72
  73     ULONG               cur_index;      /* last entry returned, for GetNextDirEntry */
  74 };
  75
  76 /* single directory entry */
  77 struct DirEntry
  78 {
  79     struct FSSuper      *sb;            /* filesystem data */
  80
  81     ULONG               cluster;        /* cluster the containing directory starts at */
  82     ULONG               index;          /* index of this entry */
  83
  84     ULONG               pos;            /* byte offset within directory that the entry came from */
  85
  86     union {
  87         struct FATDirEntry      entry;
  88         struct FATLongDirEntry  long_entry;
  89     } e;
  90 };
  91
  92 #define FAT_ROOTDIR_MARK    0xFFFFFFFFlu
  93
  94 struct GlobalLock;
  95
  96 struct ExtFileLock
  97 {
  98     /* struct FileLock */
  99     BPTR                fl_Link;
 100     IPTR                fl_Key;
 101     LONG                fl_Access;
 102     struct MsgPort *    fl_Task;
 103     BPTR                fl_Volume;
 104
 105     ULONG               magic;          /* we set this to ID_FAT_DISK so we can tell
 106                                            our locks from those of other filesystems */
 107
 108     struct MinNode      node;           /* node in the list of locks attached to the global lock */
 109     struct GlobalLock   *gl;            /* pointer to the global lock for this file */
 110
 111     struct IOHandle     ioh;            /* handle for reads and writes */
 112     ULONG               pos;            /* current seek position within the file */
 113
 114     BOOL                do_notify;      /* if set, send notification on file close (ACTION_END) */
 115     struct FSSuper      *sb;            /* pointer to sb, for unlocking when volume is removed */
 116 };
 117
 118 struct GlobalLock
 119 {
 120     struct MinNode      node;
 121
 122     ULONG               dir_cluster;    /* first cluster of the directory we're in */
 123     ULONG               dir_entry;      /* this is our dir entry within dir_cluster */
 124
 125     LONG                access;         /* access mode, shared or exclusive */
 126
 127     ULONG               first_cluster;  /* first data cluster */
 128
 129     ULONG               attr;           /* file attributes, from the dir entry */
 130     ULONG               size;           /* file size, from the dir entry */
 131
 132     UBYTE name[FAT_MAX_LONG_FILENAME];  /* copy of the name (bstr) */
 133 #if DEBUG_NAMES
 134     UBYTE shortname[FAT_MAX_SHORT_NAME + 2]; /* copy of the short name (bstr) */
 135 #endif
 136
 137     struct MinList      locks;          /* list of ExtFileLocks opened on this file */
 138 };
 139
 140 /* a node in the list of notification requests */
 141 struct NotifyNode
 142 {
 143     struct MinNode          node;
 144
 145     struct GlobalLock       *gl;        /* pointer to global lock if this file is
 146                                            locked. if it's not, this is NULL */
 147
 148     struct NotifyRequest    *nr;        /* the request that DOS passed us */
 149 };
 150
 151 struct VolumeInfo
 152 {
 153     APTR mem_pool;
 154     ULONG id;
 155     struct MinList locks;           /* global locks */
 156     struct GlobalLock root_lock;
 157     struct MinList notifies;
 158 };
 159
 160 struct VolumeIdentity
 161 {
 162     UBYTE               name[FAT_MAX_SHORT_NAME + 2];     /* BCPL string */
 163     struct DateStamp    create_time;
 164 };
 165
 166 struct FSSuper
 167 {
 168     struct Node node;
 169
 170     struct Globals *glob;
 171     struct DosList *doslist;
 172
 173     struct VolumeInfo *info;
 174
 175     struct cache *cache;
 176     ULONG first_device_sector;
 177
 178     ULONG sectorsize;
 179     ULONG sectorsize_bits;
 180
 181     ULONG cluster_sectors;
 182     ULONG clustersize;
 183     ULONG clustersize_bits;
 184     ULONG cluster_sectors_bits;
 185
 186     ULONG first_fat_sector;
 187     ULONG first_data_sector;
 188     ULONG first_rootdir_sector;
 189
 190     ULONG rootdir_sectors;
 191     ULONG total_sectors;
 192     ULONG data_sectors;
 193     ULONG clusters_count;
 194     ULONG fat_size;
 195     UWORD fat_count;
 196
 197     ULONG free_clusters;
 198     ULONG next_cluster;
 199
 200     ULONG volume_id;
 201     ULONG type;
 202     ULONG eoc_mark;
 203
 204     APTR  *fat_blocks;
 205     UBYTE **fat_buffers;
 206     ULONG fat_blocks_count;
 207
 208     ULONG fat_cachesize;
 209     ULONG fat_cachesize_bits;
 210     ULONG fat_cache_block;
 211     UWORD fat_cache_no;    /* FAT number that cached FAT blocks belong to */
 212
 213     APTR fsinfo_block;
 214     struct FATFSInfo *fsinfo_buffer;
 215
 216     ULONG rootdir_cluster;
 217     ULONG rootdir_sector;
 218
 219     struct VolumeIdentity volume;
 220
 221     /* function table */
 222     ULONG (*func_get_fat_entry)(struct FSSuper *sb, ULONG n);
 223     void  (*func_set_fat_entry)(struct FSSuper *sb, ULONG n, ULONG val);
 224     /* ... */
 225 };
 226
 227 struct Globals
 228 {
 229     /* Libraries */
 230     struct ExecBase *gl_SysBase;
 231     struct DosLibrary *gl_DOSBase;
 232     struct Library *gl_UtilityBase;
 233     struct Device *gl_TimerBase;
 234
 235     /* mem/task */
 236     struct Task *ourtask;
 237     struct MsgPort *ourport;
 238     APTR mempool;
 239
 240     struct MsgPort *notifyport;
 241
 242     /* fs */
 243     struct DosList *devnode;
 244     struct FileSysStartupMsg *fssm;
 245     LONG quit;
 246     struct DosPacket *death_packet;
 247     BOOL autodetect;
 248
 249     /* io */
 250     struct IOExtTD *diskioreq;
 251     struct IOExtTD *diskchgreq;
 252     struct MsgPort *diskport;
 253     ULONG diskchgsig_bit;
 254     struct timerequest *timereq;
 255     struct MsgPort *timerport;
 256     ULONG last_num;    /* last block number that was outside boundaries */
 257     UWORD readcmd;
 258     UWORD writecmd;
 259     char timer_active;
 260     char restart_timer;
 261
 262     /* volumes */
 263     struct FSSuper *sb;    /* current sb */
 264     struct MinList sblist;   /* sbs with outstanding locks or notifies */
 265
 266     /* disk status */
 267     LONG disk_inserted;
 268     LONG disk_inhibited;
 269     BOOL formatting;
 270
 271     /* Character sets translation */
 272     UBYTE from_unicode[65536];
 273     UWORD to_unicode[256];
 274
 275     /* Disk change interrupt */
 276     struct IntData {
 277         struct Interrupt Interrupt;
 278         struct ExecBase *SysBase;
 279         struct Task *task;
 280         ULONG signal;
 281     } DiskChangeIntData;
 282 };
 283
 284 #define DOSBase (glob->gl_DOSBase)
 285 #define SysBase (glob->gl_SysBase)
 286 #define UtilityBase (glob->gl_UtilityBase)
 287 #define TimerBase (glob->gl_TimerBase)
 288
 289 #include "support.h"
 290
 291 /* new definitions as we refactor the code */
 292
 293 /* get the first sector of a cluster */
 294 #define SECTOR_FROM_CLUSTER(sb,cl) \
 295     ((ULONG) (((cl-2) << sb->cluster_sectors_bits) + sb->first_data_sector))
 296
 297 #define FIRST_FILE_CLUSTER(de) \
 298     (AROS_LE2WORD((de)->e.entry.first_cluster_lo) | \
 299      (((ULONG) AROS_LE2WORD((de)->e.entry.first_cluster_hi)) << 16))
 300
 301 #define RESET_HANDLE(ioh) \
 302     do \
 303     { \
 304         (ioh)->cluster_offset = (ioh)->sector_offset = 0xffffffff; \
 305         if ((ioh)->block != NULL) \
 306         { \
 307             Cache_FreeBlock((ioh)->sb->cache, (ioh)->block); \
 308             (ioh)->block = NULL; \
 309         } \
 310     } \
 311     while (0);
 312
 313 #define RESET_DIRHANDLE(dh) \
 314     do \
 315     { \
 316         RESET_HANDLE(&((dh)->ioh)); \
 317         (dh)->cur_index = 0xffffffff; \
 318     } \
 319     while(0);
 320
 321 #define GET_NEXT_CLUSTER(sb,cl)     (sb->func_get_fat_entry(sb,cl))
 322 #define SET_NEXT_CLUSTER(sb,cl,val) (sb->func_set_fat_entry(sb,cl,val))
 323
 324 #define CALC_SHORT_NAME_CHECKSUM(name,checksum) \
 325     do \
 326     { \
 327         ULONG i; \
 328         checksum = 0; \
 329         for (i = 0; i < 11; i++) \
 330             checksum = \
 331                 ((checksum & 1) ? 0x80 : 0) + (checksum >> 1) + name[i]; \
 332     } \
 333     while(0);
 334
 335 #define LOCKFROMNODE(A) \
 336     ((struct ExtFileLock *) \
 337     (((BYTE *)(A)) - (IPTR)&((struct ExtFileLock *)NULL)->node))
 338
 339 #endif