[emu･fat] implement emu disk detection and pc98 partition, bpb

Author: umjammer

README.md

@@ -37,6 +37,7 @@ https://jitpack.io/#umjammer/vavi-nio-file-discutils
 | iSCSI    | 🚫   |        |          |      |      |    |       |       |       |        | server [jscsi](https://github.com/sebastiangraf/jSCSI)   |
 | NFS      | 🚫   |        |          |      |      |    |       |       |       |        | server [nfs4j](https://github.com/dcache/nfs4j)  |
 | ODS      | 🚫   |        |          |      |      |    |       |       |       |        | server [vavi-net-ods](https://github.com/umjammer/vavi-net-ods)   |
+| EMU      | ✅ (nhd)  |        |          |      |      |    |       |       |       |        | [vavi-nio-file-emu](https://github.com/umjammer/vavi-nio-file-emu) [vavi-nio-file-fat](https://github.com/umjammer/vavi-nio-file-Fat) |
 
 ## Project Description
 
@@ -169,6 +170,6 @@ Automated CI builds are available on [Github](https://github.com/umjammer/vavi-n
  * ~~https://github.com/AssafTzurEl/discUtils/commit/3853944811a16d6220dcb6e8d408561e05569e43~~
    * img ... https://github.com/hessu/bchunk
  * ~~file separator~~
- * pc98 partition (wip)
+ * ~~pc98 partition~~ (done)
  * d88 floppy disk
  * qcow2

pom.xml

@@ -196,7 +196,7 @@
     <dependency>
       <groupId>vavi</groupId>
       <artifactId>vavi-nio-file-emu</artifactId>
-      <version>2.0.0</version>
+      <version>2.0.1-SNAPSHOT</version>
     </dependency>
 
     <dependency>

src/main/java/discUtils/core/FileSystemManager.java

@@ -27,10 +27,12 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.ServiceLoader;
+import java.util.logging.Level;
 
 import discUtils.core.vfs.VfsFileSystemFactory;
 import dotnet4j.io.BufferedStream;
 import dotnet4j.io.Stream;
+import vavi.util.Debug;
 
 
 /**
@@ -85,8 +87,10 @@ private static List<FileSystemInfo> doDetect(Stream stream, VolumeInfo volume) {
         BufferedStream detectStream = new BufferedStream(stream);
         List<FileSystemInfo> detected = new ArrayList<>();
         for (VfsFileSystemFactory factory : factories) {
+Debug.println(Level.FINE, factory);
             detected.addAll(Arrays.asList(factory.detect(detectStream, volume)));
         }
+Debug.println(Level.FINE, detected);
         return detected;
     }
 }

src/main/java/discUtils/core/VirtualDiskLayer.java

@@ -40,6 +40,7 @@
  * through to the layer underneath (all other layers).
  */
 public abstract class VirtualDiskLayer implements Closeable {
+
     /**
      * Gets the capacity of the disk (in bytes).
      */
@@ -76,9 +77,9 @@ public String getFullPath() {
 
     /**
      * Gets a {@link FileLocator} that can resolve relative paths, or
-     * {@code null} .
+     * {@code null}.
      *
-     * Typically used to locate parent disks.
+     * Typically, used to locate parent disks.
      */
     public abstract FileLocator getRelativeFileLocator();
 

src/main/java/discUtils/core/partitions/BiosPartitionRecord.java

@@ -88,7 +88,7 @@ public int getIndex() {
     }
 
     public boolean isValid() {
-        return endHead != 0 || endSector != 0 || endCylinder != 0 || lbaLength != 0;
+        return partitionType != 0 && (endHead != 0 || endSector != 0 || endCylinder != 0 || lbaLength != 0);
     }
 
     private int lbaLength;
@@ -181,4 +181,22 @@ public void writeTo(byte[] buffer, int offset) {
         EndianUtilities.writeBytesLittleEndian(lbaStart, buffer, offset + 8);
         EndianUtilities.writeBytesLittleEndian(lbaLength, buffer, offset + 12);
     }
+
+    @Override
+    public String toString() {
+        return "BiosPartitionRecord{" +
+                "lbaOffset=" + lbaOffset +
+                ", endCylinder=" + endCylinder +
+                ", endHead=" + endHead +
+                ", endSector=" + endSector +
+                ", index=" + index +
+                ", lbaLength=" + lbaLength +
+                ", lbaStart=" + lbaStart +
+                ", partitionType=" + partitionType +
+                ", startCylinder=" + startCylinder +
+                ", startHead=" + startHead +
+                ", startSector=" + startSector +
+                ", status=" + status +
+                '}';
+    }
 }

src/main/java/discUtils/core/partitions/BiosPartitionTable.java

@@ -41,6 +41,7 @@
 import discUtils.streams.util.Sizes;
 import discUtils.streams.util.StreamUtilities;
 import dotnet4j.io.Stream;
+import vavi.util.Debug;
 
 
 /**
@@ -160,7 +161,7 @@ public static boolean isValid(Stream disk) {
         for (BiosPartitionRecord record : readPrimaryRecords(bootSector)) {
             // If the partition extends beyond the end of the disk, this is
             // probably an invalid partition table
-            if (record.getLBALength() != 0xFFFFFFFF &&
+            if (record.getLBALength() != 0xFFFF_FFFF &&
                 (record.getLBAStart() + record.getLBALength()) * Sizes.Sector > disk.getLength()) {
                 return false;
             }

src/main/java/discUtils/core/partitions/PartitionTable.java

@@ -26,11 +26,13 @@
 import java.util.List;
 import java.util.ServiceLoader;
 import java.util.UUID;
+import java.util.logging.Level;
 
 import discUtils.core.VirtualDisk;
 import discUtils.core.raw.Disk;
 import discUtils.streams.util.Ownership;
 import dotnet4j.io.Stream;
+import vavi.util.Debug;
 
 
 /**
@@ -115,9 +117,12 @@ public static List<PartitionTable> getPartitionTables(VirtualDisk disk) {
         for (PartitionTableFactory factory : factories) {
             PartitionTable table = factory.detectPartitionTable(disk);
             if (table != null) {
+Debug.println(Level.FINE, factory + ", " + table);
                 tables.add(table);
             }
+            factory.adhoc(tables);
         }
+Debug.println(Level.FINE, tables);
         return tables;
     }
 

src/main/java/discUtils/core/partitions/PartitionTableFactory.java

@@ -22,6 +22,8 @@
 
 package discUtils.core.partitions;
 
+import java.util.List;
+
 import discUtils.core.VirtualDisk;
 import dotnet4j.io.Stream;
 
@@ -46,4 +48,7 @@ public interface PartitionTableFactory {
     boolean detectIsPartitioned(Stream s);
 
     PartitionTable detectPartitionTable(VirtualDisk disk);
+
+    default void adhoc(List<PartitionTable> tables) {
+    }
 }

src/main/java/discUtils/core/pc98/Pc98BootSector.java

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2022 by Naohide Sano, All rights reserved.
+ *
+ * Programmed by Naohide Sano
+ */
+
+package discUtils.core.pc98;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+
+import discUtils.fat.BootSector;
+import discUtils.fat.FatType;
+import discUtils.streams.util.StreamUtilities;
+import dotnet4j.io.Stream;
+import vavi.util.serdes.Serdes;
+import vavix.io.fat.PC98BiosParameterBlock;
+
+
+/**
+ * Pc98BootSector.
+ *
+ * @author <a href="mailto:umjammer@gmail.com">Naohide Sano</a> (nsano)
+ * @version 0.00 2022-08-06 nsano initial version <br>
+ */
+public class Pc98BootSector implements BootSector {
+
+    private PC98BiosParameterBlock bpb;
+
+    public Pc98BootSector(Stream stream) {
+        try {
+            byte[] sector = StreamUtilities.readExact(stream, 512);
+            ByteArrayInputStream bais = new ByteArrayInputStream(sector);
+
+            this.bpb = new PC98BiosParameterBlock();
+            Serdes.Util.deserialize(bais, bpb);
+//System.err.println("■ bootRecord ----\n" + bpb);
+            bpb.compute();
+//System.err.println("■ bootRecord ----\n" + bpb);
+        } catch (IOException e) {
+            throw new dotnet4j.io.IOException(e);
+        }
+    }
+
+    @Override
+    public int getFatCount() {
+        return bpb.numberOfFAT;
+    }
+
+    @Override
+    public byte getActiveFat() {
+        return 0;
+    }
+
+    @Override
+    public int getBytesPerSector() {
+        return bpb.getBytesPerSector();
+    }
+
+    @Override
+    public long getFatSize() {
+        return bpb.numberOfFATSector;
+    }
+
+    @Override
+    public FatType getFatVariant() {
+        return FatType.valueOf(bpb.getFatType().getValue());
+    }
+
+    @Override
+    public String getOemName() {
+        return bpb.oemLabel;
+    }
+
+    @Override
+    public int getReservedSectorCount() {
+        return bpb.reservedSectors;
+    }
+
+    @Override
+    public int getSectorsPerCluster() {
+        return bpb.getSectorsPerCluster();
+    }
+
+    @Override
+    public long getTotalSectors() {
+        return bpb.numberOfSmallSectors != 0 ? bpb.numberOfSmallSectors : bpb.numberOfLargeSectors;
+    }
+
+    @Override
+    public String getVolumeLabel() {
+        return bpb.volumeLabel;
+    }
+
+    @Override
+    public int getMaxRootDirectoryEntries() {
+        return bpb.maxRootDirectoryEntries;
+    }
+
+    @Override
+    public long getRootDirectoryCluster() {
+        return bpb.getStartClusterOfRootDirectory();
+    }
+
+    @Override
+    public int getFatSize16() {
+        return bpb.numberOfFATSector;
+    }
+}

src/main/java/discUtils/core/pc98/Pc98FileSystemFactory.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2022 by Naohide Sano, All rights reserved.
+ *
+ * Programmed by Naohide Sano
+ */
+
+package discUtils.core.pc98;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.logging.Level;
+
+import discUtils.core.DiscFileSystem;
+import discUtils.core.FileSystemInfo;
+import discUtils.core.FileSystemParameters;
+import discUtils.core.VolumeInfo;
+import discUtils.core.coreCompat.EncodingHelper;
+import discUtils.core.vfs.VfsFileSystemFactory;
+import discUtils.core.vfs.VfsFileSystemInfo;
+import discUtils.fat.BootSector;
+import discUtils.fat.FatFileSystem;
+import discUtils.streams.util.Ownership;
+import discUtils.streams.util.StreamUtilities;
+import dotnet4j.io.Stream;
+import vavi.util.Debug;
+import vavi.util.serdes.Serdes;
+import vavix.io.fat.PC98BiosParameterBlock;
+
+
+/**
+ * Pc98FileSystemFactory.
+ *
+ * @author <a href="mailto:umjammer@gmail.com">Naohide Sano</a> (nsano)
+ * @version 0.00 2022-07-24 nsano initial version <br>
+ */
+public class Pc98FileSystemFactory implements VfsFileSystemFactory {
+
+    public FileSystemInfo[] detect(Stream stream, VolumeInfo volume) {
+        if (detectFAT(stream)) {
+            return new FileSystemInfo[] {
+                new VfsFileSystemInfo("PC98_FAT", "NEC FAT", this::open)
+            };
+        }
+
+        return new FileSystemInfo[0];
+    }
+
+    private DiscFileSystem open(Stream stream, VolumeInfo volumeInfo, FileSystemParameters parameters) {
+        BootSector bs = new Pc98BootSector(stream);
+        parameters.setFileNameEncoding(EncodingHelper.forCodePage(932)); // TODO system property
+        return new FatFileSystem(stream, bs, Ownership.None, parameters);
+    }
+
+    /**
+     * Detects if a stream contains a FAT file system.
+     *
+     * @param stream The stream to inspect.
+     * @return {@code true} if the stream appears to be a FAT file system, else
+     *         {@code false}.
+     */
+    private static boolean detectFAT(Stream stream) {
+        if (stream.getLength() < 512) {
+Debug.println(Level.FINE, "stream length < 512");
+            return false;
+        }
+
+        stream.setPosition(0);
+        byte[] sector = StreamUtilities.readExact(stream, 512);
+        ByteArrayInputStream bais = new ByteArrayInputStream(sector);
+
+        PC98BiosParameterBlock bpb;
+        try {
+            bpb = new PC98BiosParameterBlock();
+            Serdes.Util.deserialize(bais, bpb);
+        } catch (IOException e) {
+Debug.println(Level.FINE, e);
+            return false;
+        }
+
+        return bpb.validate();
+    }
+}