// /*************************************************************************** // The Disc Image Chef // ---------------------------------------------------------------------------- // // Filename : ODS.cs // Author(s) : Natalia Portillo // // Component : Files-11 On-Disk Structure plugin. // // --[ Description ] ---------------------------------------------------------- // // Identifies the Files-11 On-Disk Structure and shows information. // // --[ License ] -------------------------------------------------------------- // // This library is free software; you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as // published by the Free Software Foundation; either version 2.1 of the // License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, see . // // ---------------------------------------------------------------------------- // Copyright © 2011-2018 Natalia Portillo // ****************************************************************************/ using System; using System.Collections.Generic; using System.Runtime.InteropServices; using System.Text; using DiscImageChef.CommonTypes; using DiscImageChef.Console; namespace DiscImageChef.Filesystems { // Information from VMS File System Internals by Kirby McCoy // ISBN: 1-55558-056-4 // With some hints from http://www.decuslib.com/DECUS/vmslt97b/gnusoftware/gccaxp/7_1/vms/hm2def.h // Expects the home block to be always in sector #1 (does not check deltas) // Assumes a sector size of 512 bytes (VMS does on HDDs and optical drives, dunno about M.O.) // Book only describes ODS-2. Need to test ODS-1 and ODS-5 // There is an ODS with signature "DECFILES11A", yet to be seen // Time is a 64 bit unsigned integer, tenths of microseconds since 1858/11/17 00:00:00. // TODO: Implement checksum public class ODS : Filesystem { public ODS() { Name = "Files-11 On-Disk Structure"; PluginUUID = new Guid("de20633c-8021-4384-aeb0-83b0df14491f"); CurrentEncoding = Encoding.GetEncoding("iso-8859-1"); } public ODS(Encoding encoding) { Name = "Files-11 On-Disk Structure"; PluginUUID = new Guid("de20633c-8021-4384-aeb0-83b0df14491f"); if(encoding == null) CurrentEncoding = Encoding.GetEncoding("iso-8859-1"); else CurrentEncoding = encoding; } public ODS(DiscImages.ImagePlugin imagePlugin, Partition partition, Encoding encoding) { Name = "Files-11 On-Disk Structure"; PluginUUID = new Guid("de20633c-8021-4384-aeb0-83b0df14491f"); if(encoding == null) CurrentEncoding = Encoding.GetEncoding("iso-8859-1"); else CurrentEncoding = encoding; } public override bool Identify(DiscImages.ImagePlugin imagePlugin, Partition partition) { if((2 + partition.Start) >= partition.End) return false; if(imagePlugin.GetSectorSize() < 512) return false; byte[] magic_b = new byte[12]; string magic; byte[] hb_sector = imagePlugin.ReadSector(1 + partition.Start); Array.Copy(hb_sector, 0x1F0, magic_b, 0, 12); magic = Encoding.ASCII.GetString(magic_b); DicConsole.DebugWriteLine("Files-11 plugin", "magic: \"{0}\"", magic); if(magic == "DECFILE11A " || magic == "DECFILE11B ") return true; // Optical disc if(imagePlugin.ImageInfo.XmlMediaType == DiscImages.XmlMediaType.OpticalDisc) { if(hb_sector.Length < 0x400) return false; hb_sector = imagePlugin.ReadSector(partition.Start); Array.Copy(hb_sector, 0x3F0, magic_b, 0, 12); magic = Encoding.ASCII.GetString(magic_b); DicConsole.DebugWriteLine("Files-11 plugin", "unaligned magic: \"{0}\"", magic); if(magic == "DECFILE11A " || magic == "DECFILE11B ") return true; } return false; } public override void GetInformation(DiscImages.ImagePlugin imagePlugin, Partition partition, out string information) { information = ""; StringBuilder sb = new StringBuilder(); ODSHomeBlock homeblock = new ODSHomeBlock(); byte[] temp_string = new byte[12]; homeblock.min_class = new byte[20]; homeblock.max_class = new byte[20]; byte[] hb_sector = imagePlugin.ReadSector(1 + partition.Start); GCHandle handle = GCHandle.Alloc(hb_sector, GCHandleType.Pinned); homeblock = (ODSHomeBlock)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(ODSHomeBlock)); handle.Free(); // Optical disc if(imagePlugin.ImageInfo.XmlMediaType == DiscImages.XmlMediaType.OpticalDisc && StringHandlers.CToString(homeblock.format) != "DECFILE11A " && StringHandlers.CToString(homeblock.format) != "DECFILE11B ") { if(hb_sector.Length < 0x400) return; byte[] tmp = imagePlugin.ReadSector(partition.Start); hb_sector = new byte[0x200]; Array.Copy(tmp, 0x200, hb_sector, 0, 0x200); handle = GCHandle.Alloc(hb_sector, GCHandleType.Pinned); homeblock = (ODSHomeBlock)Marshal.PtrToStructure(handle.AddrOfPinnedObject(), typeof(ODSHomeBlock)); handle.Free(); if(StringHandlers.CToString(homeblock.format) != "DECFILE11A " && StringHandlers.CToString(homeblock.format) != "DECFILE11B ") return; } if((homeblock.struclev & 0xFF00) != 0x0200 || (homeblock.struclev & 0xFF) != 1 || StringHandlers.CToString(homeblock.format) != "DECFILE11B ") sb.AppendLine("The following information may be incorrect for this volume."); if(homeblock.resfiles < 5 || homeblock.devtype != 0) sb.AppendLine("This volume may be corrupted."); sb.AppendFormat("Volume format is {0}", StringHandlers.SpacePaddedToString(homeblock.format, CurrentEncoding)).AppendLine(); sb.AppendFormat("Volume is Level {0} revision {1}", (homeblock.struclev & 0xFF00) >> 8, homeblock.struclev & 0xFF).AppendLine(); sb.AppendFormat("Lowest structure in the volume is Level {0}, revision {1}", (homeblock.lowstruclev & 0xFF00) >> 8, homeblock.lowstruclev & 0xFF).AppendLine(); sb.AppendFormat("Highest structure in the volume is Level {0}, revision {1}", (homeblock.highstruclev & 0xFF00) >> 8, homeblock.highstruclev & 0xFF).AppendLine(); sb.AppendFormat("{0} sectors per cluster ({1} bytes)", homeblock.cluster, homeblock.cluster * 512) .AppendLine(); sb.AppendFormat("This home block is on sector {0} (VBN {1})", homeblock.homelbn, homeblock.homevbn) .AppendLine(); sb.AppendFormat("Secondary home block is on sector {0} (VBN {1})", homeblock.alhomelbn, homeblock.alhomevbn) .AppendLine(); sb.AppendFormat("Volume bitmap starts in sector {0} (VBN {1})", homeblock.ibmaplbn, homeblock.ibmapvbn) .AppendLine(); sb.AppendFormat("Volume bitmap runs for {0} sectors ({1} bytes)", homeblock.ibmapsize, homeblock.ibmapsize * 512).AppendLine(); sb.AppendFormat("Backup INDEXF.SYS;1 is in sector {0} (VBN {1})", homeblock.altidxlbn, homeblock.altidxvbn) .AppendLine(); sb.AppendFormat("{0} maximum files on the volume", homeblock.maxfiles).AppendLine(); sb.AppendFormat("{0} reserved files", homeblock.resfiles).AppendLine(); if(homeblock.rvn > 0 && homeblock.setcount > 0 && StringHandlers.CToString(homeblock.strucname) != " ") sb.AppendFormat("Volume is {0} of {1} in set \"{2}\".", homeblock.rvn, homeblock.setcount, StringHandlers.SpacePaddedToString(homeblock.strucname, CurrentEncoding)).AppendLine(); sb.AppendFormat("Volume owner is \"{0}\" (ID 0x{1:X8})", StringHandlers.SpacePaddedToString(homeblock.ownername, CurrentEncoding), homeblock.volowner).AppendLine(); sb.AppendFormat("Volume label: \"{0}\"", StringHandlers.SpacePaddedToString(homeblock.volname, CurrentEncoding)).AppendLine(); sb.AppendFormat("Drive serial number: 0x{0:X8}", homeblock.serialnum).AppendLine(); sb.AppendFormat("Volume was created on {0}", DateHandlers.VMSToDateTime(homeblock.credate)).AppendLine(); if(homeblock.revdate > 0) sb.AppendFormat("Volume was last modified on {0}", DateHandlers.VMSToDateTime(homeblock.revdate)) .AppendLine(); if(homeblock.copydate > 0) sb.AppendFormat("Volume copied on {0}", DateHandlers.VMSToDateTime(homeblock.copydate)).AppendLine(); sb.AppendFormat("Checksums: 0x{0:X4} and 0x{1:X4}", homeblock.checksum1, homeblock.checksum2).AppendLine(); sb.AppendLine("Flags:"); sb.AppendFormat("Window: {0}", homeblock.window).AppendLine(); sb.AppendFormat("Cached directores: {0}", homeblock.lru_lim).AppendLine(); sb.AppendFormat("Default allocation: {0} blocks", homeblock.extend).AppendLine(); if((homeblock.volchar & 0x01) == 0x01) sb.AppendLine("Readings should be verified"); if((homeblock.volchar & 0x02) == 0x02) sb.AppendLine("Writings should be verified"); if((homeblock.volchar & 0x04) == 0x04) sb.AppendLine("Files should be erased or overwritten when deleted"); if((homeblock.volchar & 0x08) == 0x08) sb.AppendLine("Highwater mark is to be disabled"); if((homeblock.volchar & 0x10) == 0x10) sb.AppendLine("Classification checks are enabled"); sb.AppendLine("Volume permissions (r = read, w = write, c = create, d = delete)"); sb.AppendLine("System, owner, group, world"); // System if((homeblock.protect & 0x1000) == 0x1000) sb.Append("-"); else sb.Append("r"); if((homeblock.protect & 0x2000) == 0x2000) sb.Append("-"); else sb.Append("w"); if((homeblock.protect & 0x4000) == 0x4000) sb.Append("-"); else sb.Append("c"); if((homeblock.protect & 0x8000) == 0x8000) sb.Append("-"); else sb.Append("d"); // Owner if((homeblock.protect & 0x100) == 0x100) sb.Append("-"); else sb.Append("r"); if((homeblock.protect & 0x200) == 0x200) sb.Append("-"); else sb.Append("w"); if((homeblock.protect & 0x400) == 0x400) sb.Append("-"); else sb.Append("c"); if((homeblock.protect & 0x800) == 0x800) sb.Append("-"); else sb.Append("d"); // Group if((homeblock.protect & 0x10) == 0x10) sb.Append("-"); else sb.Append("r"); if((homeblock.protect & 0x20) == 0x20) sb.Append("-"); else sb.Append("w"); if((homeblock.protect & 0x40) == 0x40) sb.Append("-"); else sb.Append("c"); if((homeblock.protect & 0x80) == 0x80) sb.Append("-"); else sb.Append("d"); // World (other) if((homeblock.protect & 0x1) == 0x1) sb.Append("-"); else sb.Append("r"); if((homeblock.protect & 0x2) == 0x2) sb.Append("-"); else sb.Append("w"); if((homeblock.protect & 0x4) == 0x4) sb.Append("-"); else sb.Append("c"); if((homeblock.protect & 0x8) == 0x8) sb.Append("-"); else sb.Append("d"); sb.AppendLine(); sb.AppendLine("Unknown structures:"); sb.AppendFormat("Security mask: 0x{0:X8}", homeblock.sec_mask).AppendLine(); sb.AppendFormat("File protection: 0x{0:X4}", homeblock.fileprot).AppendLine(); sb.AppendFormat("Record protection: 0x{0:X4}", homeblock.recprot).AppendLine(); xmlFSType = new Schemas.FileSystemType { Type = "FILES-11", ClusterSize = homeblock.cluster * 512, Clusters = (long)(partition.Size) / (homeblock.cluster * 512), VolumeName = StringHandlers.SpacePaddedToString(homeblock.volname, CurrentEncoding), VolumeSerial = string.Format("{0:X8}", homeblock.serialnum) }; if(homeblock.credate > 0) { xmlFSType.CreationDate = DateHandlers.VMSToDateTime(homeblock.credate); xmlFSType.CreationDateSpecified = true; } if(homeblock.revdate > 0) { xmlFSType.ModificationDate = DateHandlers.VMSToDateTime(homeblock.revdate); xmlFSType.ModificationDateSpecified = true; } information = sb.ToString(); } [StructLayout(LayoutKind.Sequential, Pack = 1)] struct ODSHomeBlock { /// 0x000, LBN of THIS home block public uint homelbn; /// 0x004, LBN of the secondary home block public uint alhomelbn; /// 0x008, LBN of backup INDEXF.SYS;1 public uint altidxlbn; /// 0x00C, High byte contains filesystem version (1, 2 or 5), low byte contains revision (1) public ushort struclev; /// 0x00E, Number of blocks each bit of the volume bitmap represents public ushort cluster; /// 0x010, VBN of THIS home block public ushort homevbn; /// 0x012, VBN of the secondary home block public ushort alhomevbn; /// 0x014, VBN of backup INDEXF.SYS;1 public ushort altidxvbn; /// 0x016, VBN of the bitmap public ushort ibmapvbn; /// 0x018, LBN of the bitmap public uint ibmaplbn; /// 0x01C, Max files on volume public uint maxfiles; /// 0x020, Bitmap size in sectors public ushort ibmapsize; /// 0x022, Reserved files, 5 at minimum public ushort resfiles; /// 0x024, Device type, ODS-2 defines it as always 0 public ushort devtype; /// 0x026, Relative volume number (number of the volume in a set) public ushort rvn; /// 0x028, Total number of volumes in the set this volume is public ushort setcount; /// 0x02A, Flags public ushort volchar; /// 0x02C, User ID of the volume owner public uint volowner; /// 0x030, Security mask (??) public uint sec_mask; /// 0x034, Volume permissions (system, owner, group and other) public ushort protect; /// 0x036, Default file protection, unsupported in ODS-2 public ushort fileprot; /// 0x038, Default file record protection public ushort recprot; /// 0x03A, Checksum of all preceding entries public ushort checksum1; /// 0x03C, Creation date public ulong credate; /// 0x044, Window size (pointers for the window) public byte window; /// 0x045, Directories to be stored in cache public byte lru_lim; /// 0x046, Default allocation size in blocks public ushort extend; /// 0x048, Minimum file retention period public ulong retainmin; /// 0x050, Maximum file retention period public ulong retainmax; /// 0x058, Last modification date public ulong revdate; /// 0x060, Minimum security class, 20 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 20)] public byte[] min_class; /// 0x074, Maximum security class, 20 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 20)] public byte[] max_class; /// 0x088, File lookup table FID public ushort filetab_fid1; /// 0x08A, File lookup table FID public ushort filetab_fid2; /// 0x08C, File lookup table FID public ushort filetab_fid3; /// 0x08E, Lowest structure level on the volume public ushort lowstruclev; /// 0x090, Highest structure level on the volume public ushort highstruclev; /// 0x092, Volume copy date (??) public ulong copydate; /// 0x09A, 302 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 302)] public byte[] reserved1; /// 0x1C8, Physical drive serial number public uint serialnum; /// 0x1CC, Name of the volume set, 12 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 12)] public byte[] strucname; /// 0x1D8, Volume label, 12 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 12)] public byte[] volname; /// 0x1E4, Name of the volume owner, 12 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 12)] public byte[] ownername; /// 0x1F0, ODS-2 defines it as "DECFILE11B", 12 bytes [MarshalAs(UnmanagedType.ByValArray, SizeConst = 12)] public byte[] format; /// 0x1FC, Reserved public ushort reserved2; /// 0x1FE, Checksum of preceding 255 words (16 bit units) public ushort checksum2; } public override Errno Mount() { return Errno.NotImplemented; } public override Errno Mount(bool debug) { return Errno.NotImplemented; } public override Errno Unmount() { return Errno.NotImplemented; } public override Errno MapBlock(string path, long fileBlock, ref long deviceBlock) { return Errno.NotImplemented; } public override Errno GetAttributes(string path, ref FileAttributes attributes) { return Errno.NotImplemented; } public override Errno ListXAttr(string path, ref List xattrs) { return Errno.NotImplemented; } public override Errno GetXattr(string path, string xattr, ref byte[] buf) { return Errno.NotImplemented; } public override Errno Read(string path, long offset, long size, ref byte[] buf) { return Errno.NotImplemented; } public override Errno ReadDir(string path, ref List contents) { return Errno.NotImplemented; } public override Errno StatFs(ref FileSystemInfo stat) { return Errno.NotImplemented; } public override Errno Stat(string path, ref FileEntryInfo stat) { return Errno.NotImplemented; } public override Errno ReadLink(string path, ref string dest) { return Errno.NotImplemented; } } }