home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / prgramer / info / eadata.txt < prev    next >
Text File  |  1992-02-23  |  10KB  |  191 lines
  1. The following text was captured by Jim Gilliland and posted in the Fidonet
  2. OS2 echo conference.  His introduction follows.  -Pete Norloff
  3.  
  4.  
  5. Here is a description of the extended attribute mechanism for FAT
  6. partitions.  This document appears to have made the rounds of UseNet,
  7. Compuserve, BIX, etc.  It appears to be reasonably well researched,
  8. but I cannot speak for its correctness.  Hope it proves useful and/or
  9. educational.
  10.  
  11. ==============================================================================
  12.  
  13. The EA DATA. SF file, and what it does
  14. ======================================
  15.  
  16. I originally wrote this because of all the queries about the file named
  17. EA DATA. SF file which is a frequent subject of discussion.  I have
  18. tried to explain what it does, why it exists, and what you should and
  19. should not do with it.  Various people on CompuServe have given me extra
  20. information; particular thanks to Dean Gibson (73427,2072) who figured
  21. out the format of the EA DATA.  SF file and put me right on a few
  22. points.  Some of the following information (and nearly all of Appendix
  23. A) is due to Dean.
  24.  
  25. OS/2 1.2 and beyond support the concept of "extended attributes" (EAs)
  26. on files.  These are used for all kinds of things, and can be very small
  27. or quite large (the limit is 64K per file at present).  EAs might
  28. represent a file type, a file classification, an icon type, some free
  29. text...practically anything.  Use the Properties entry in the File
  30. pulldown on the File Manager to see the EAs on a specified file
  31. (actually, I have found that Properties doesn't seem to tell you
  32. absolutely everything).
  33.  
  34. EAs are supported directly by the High Performance File System (HPFS).
  35. They are stored in an efficient manner; a small EA does not effectively
  36. take any additional space most of the time (typically, if it is less
  37. than several hundred bytes).
  38.  
  39. However, for backwards compatibility the DOS (File Allocation Table, or
  40. FAT) file system needs to support EAs too.  In order to do this, and
  41. keep the file system consistent for DOS if it is booted instead of OS/2
  42. on the same machine, some trickery is needed.
  43.  
  44. FAT directory entries have ten spare bytes in them, starting at offset
  45. 0CH (immediately after the filename and the attribute byte); these are
  46. normally zero.  They are there because originally the directory entry
  47. layout was modelled on the CP/M file system, and these bytes (among
  48. others) were used to describe the location of the disk extents making up
  49. the file; they aren't used for that purpose under DOS.  Two of these
  50. spare bytes (at offsets 14H and 15H within the directory entry) are used
  51. to head a chain of disk allocation units (or clusters) which hold the
  52. EAs for that file.  This causes interesting problems (for example) with
  53. early versions of the Norton Utilities, which flag the directory entry
  54. as one with an "illegal" format!  So, effectively an OS/2 FAT directory
  55. entry can head two chains of clusters; one for the file itself (as
  56. usual) and one for the EAs attached to the file.  The latter listhead is
  57. often null.
  58.  
  59. All this would be fine until you ran CHKDSK under DOS.  It would find
  60. all these clusters holding the EAs, and because they would appear not to
  61. belong to any file, they would be collected up and marked as "lost"
  62. clusters to be added to the free list.  Disaster next time OS/2 looked
  63. at the file (well, eventually anyway) because the chances are that the
  64. clusters making up the EAs would have been allocated to another file by
  65. that time.  To prevent this, the file named EA DATA. SF (the EA
  66. datafile) is used.  This file is never meant to be read directly.  Its
  67. directory entry heads a chain of clusters (as usual), but these clusters
  68. are the SAME ones that hold all the EAs on that disk.  In other words,
  69. there are two references to every EA cluster; one via the file's
  70. directory entry and one via the EA datafile.  This makes the disk appear
  71. consistent under DOS; all of the clusters used on the disk belong to a
  72. valid file.  Microsoft say that the EA datafile is position dependent,
  73. and it shouldn't be manipulated or deleted; to make this hard, it has a
  74. strange name with spaces in it (which defeats a lot of software), and it
  75. is marked readonly, system and hidden.  Observation has shown this not
  76. to be strictly true; it seems that you can back up and restore the file
  77. without any damage (of course, the EA datafile must correspond to the
  78. files on the disk; if you attempted to restore such a file on its own
  79. without also restoring the various files that reference it, you would
  80. have problems).  The snag is that restored files won't generally have
  81. the entire directory entry restored, so the head of the EA cluster chain
  82. (in offsets 14H and 15H) will be lost (set to zero).
  83.  
  84. Notice the implication for backup under OS/2.  A proper, EA-aware backup
  85. program need not back up the EA datafile; it simply reads the EAs for
  86. each file as it is backed up, and of course it restores them the same
  87. way - with system calls.  So, the fact that OS/2 locks the EA datafile
  88. open is actually a benefit of sorts - it saves the file being backed up
  89. when its contents will never be needed; and it would be semi-useless
  90. unless the directory entries were also restored in their entirety.
  91.  
  92. Why is this file so big?  I can speak only for IBM OS/2 1.2 and 1.3,
  93. which are the ones I have run.  When installing OS/2, the installation
  94. utility scans the OS/2 hard disk (if FAT) for any files it considers
  95. should have EAs on them.  This means all .EXE files for a start.  To
  96. each one it helpfully adds a short EA that marks the file as executable;
  97. this EA is 23 bytes long, but since each EA needs to be in a cluster
  98. unique to the file to which it is attached, it actually occupies a whole
  99. 2K cluster.  Note that EAs are attached at this time even to DOS .EXE
  100. files found on the disk.  In my case this used up 700K of disk space;
  101. your mileage may vary.  Incidentally, the EA datafile is created when
  102. the first EA is attached to any file on the disk; try it out with a
  103. floppy; it also takes one cluster (the first one) for some kind of
  104. internal housekeeping information.  I suspected that this cluster is
  105. some kind of map similar to the FAT, chaining together the clusters
  106. relating to one file within the EA datafile; if so, it would probably
  107. expand if you had a lot of EAs on your disk.  Dean Gibson figured out a
  108. lot more about the format of the file; the details are given in Appendix
  109. A.
  110.  
  111. You can safely delete the EAs from all your DOS files, and from many
  112. OS/2 ones.  Beware, though!  Some files have large EAs that are used for
  113. special purposes.  Ones I know of include some printer drivers, and the
  114. VIEW utility used for the online command reference.  DIR/N will show you
  115. the sizes of the EAs for each file.  To delete the EAs from all of the
  116. files in my DOS directory, I used:
  117.  
  118.     FOR %X IN (*.EXE) DO EAUTIL /S %X
  119.  
  120. This splits off the EA for each file into another file of the same name,
  121. in a subdirectory called EAS (which is created automatically).  Delete
  122. this directory and its contents to free up the space.  The clusters are
  123. automatically removed from the EA datafile at this time.  I have found
  124. this the easiest way to remove EAs.
  125.  
  126. EAs are also removed from the EA datafile if the file to which they are
  127. attached is deleted; this ONLY applies if deletion takes place under
  128. OS/2 (the DOS box will do).  If deleted under vanilla DOS, the EA
  129. datafile retains the "lost" EA clusters; they can be reclaimed by
  130. running CHKDSK under OS/2 (using the installation disk if DLLs or a
  131. swapfile are open on the disk in question).
  132.  
  133. All this of course plays havoc with defragmenters.  They have to work
  134. round all of the scattered, immobile clusters making up the EA datafile.
  135. Yes, it's a kludge; but quite a good one, given the constraint that it
  136. has to look OK under normal DOS as well as provide the functionality
  137. under OS/2.
  138.  
  139. Please let me know if you have any comments on the above; if I receive
  140. more information, I'll produce a further updated version.
  141.  
  142.  
  143. Appendix A - Notes on the format of the EA datafile
  144. ---------------------------------------------------
  145.  
  146. Most of this information came from Dean Gibson - many thanks, Dean!  I
  147. have made the occasional addition.
  148.  
  149. The actual EA DATA.  SF file format is as follows (this has been
  150. verified with both 128 & 512 byte sector disks):
  151.  
  152. The first word is for identification and contains the ASCII characters
  153. 'ED'; the next 15 words seem unused.  The next 240 words (call this
  154. "table A") contain offsets into "table B".  Table B starts at file byte
  155. offset 512 and continues for as many contiguous 128 word segments as
  156. necessary.
  157.  
  158. Given a non-zero 16 bit EA pointer "X" in a FAT system directory entry
  159. (in offsets 14H and 15H):
  160.  
  161.  1. Shift X right 7 bits, and use the result as a WORD INDEX to obtain a
  162.     word entry from table A.  Note that since a FAT system can only have
  163.     64K entries, that means a maximum of 32K files that have EA entries
  164.     (since each file and each EA takes one cluster each), so the max EA
  165.     pointer value is <32K, and thus the high-order bit of X is unused.
  166.  
  167.  2. Use X as a relative WORD INDEX into table B, to obtain the word entry
  168.     at that location.  A value of FFFFH means that the entry is unused.
  169.  
  170.  3. Add the values from steps 2 & 3 to obtain the relative CLUSTER of the EA
  171.     for the target file within EA_DATA._SF.
  172.  
  173. In order to keep the EA DATA. SF file logically contiguous when table B
  174. is expanded into a new cluster or when an EA is deleted, the FAT cluster
  175. chain for EA DATA.  SF is altered, and values in table A and/or segments
  176. of table B are changed to reflect this.
  177.  
  178. The first word of the EA sector is for identification and contains the
  179. ASCII characters 'EA'; the next word is the relative sector number of
  180. this sector (consistency check); then the next two words are zero; the
  181. next twelve bytes contain the target file name (no path); the next word
  182. has an as yet undeciphered meaning; then the next two words are zero;
  183. followed by the EA data for the target file.  The first word of the EA
  184. data is the length of the EA data in bytes, including the count word.
  185.  
  186.  
  187. Bob Eager
  188. Compuserve:    100016,2770
  189. USENET:        rde@ukc.ac.uk
  190.  
  191.