jhermsmeier/node-disk

A node library for nice & easy disk interaction

Disk

Install via npm

$ npm install --save disk

Related Modules

Internals:

• MBR – Master Boot Record
• GPT – GUID Partition Table
• CHS – Cylinder-Head-Sector Addressing
• apple-partition-map – Apple Partition Map
• BlockDevice – Block device handling
• RamDisk – In-memory block device

Block Devices:

• VHD – Microsoft Virtual Hard Disk format
• UDIF – Apple's DMG / UDIF (Universal Disk Image Format)
• UDF – OSTA Universal Disk Format

File Systems:

• FAT32 – FAT32/16/12 file system driver
• ExFAT – ExFAT file system driver
• HFSX – Apple HFS+ file system driver
• NTFS – NTFS file system driver

Usage

var Disk = require( 'disk' )

Set up a device to work with. This can be anything with a blockdevice compatible API.

var device = new BlockDevice({
  path: BlockDevice.getPath( 0 )
})

Create a disk:

var disk = new Disk( device )

Open the device:

// This also attempts to detect it's block size if unspecified,
// as well as reading the MBR & GPT on the device
disk.open( function( error ) {})

Read or write the MBR (disk.mbr) from or to the device:

disk.readMBR( function( error, mbr ) {})
disk.writeMBR( function( error ) {})

Read or write the GPT (disk.gpt) from or to the device:

disk.readGPT( function( error, gpt ) {})
disk.writeGPT( function( error ) {})

Verify the backup GPT; NOTE: The callback will be called with an error and the backup GPT if it doesn't verify.

disk.verifyGPT( function( error, backupGPT ) {})

Close the device:

disk.close( function( error ) {})

API

Disk

• Disk.MBR: See mbr
• Disk.GPT: See gpt

new Disk( device )

Properties:

• device
• mbr
• gpt

Methods:

• open( callback )
• close( callback )
• getEFIPart()
• readMBR( callback )
• writeMBR( callback )
• readGPT( callback )
• writeGPT( callback )
• writeGPT( callback ): Not implemented

node-disk's Issues

Read extended / logical partitions

Attempt to read extended / logical partitions when reading a MBRs partition table, and the partition type indicates an extended partition (i.e. partition type 0x0F).

Support partition resizing

Add methods to resize partitions:

• Support resizing extended / logical partitions
• Bounds check on device size
• Methods to resize the underlying device, when the device is an image file rather than a physical device (should probably left to be done by user?)

Use dynamic VHD images for tests

Use vhd to model entire disks including backup GPTs, file system VBRs, etc. without having image files getting too large by using sparse / dynamic VHDs

Support Apple Partition Maps

See apple-partition-map

Support writing of the GPT

Write a CONTRIBUTING.md guide

• include tools and guides on how to create disk images for testing

Support mounting of file systems

Specify & consolidate an API that file system drivers would implement to make them interoperate with node-disk, so that file systems could be automatically detected & mounted.

Prototype API Example:

var BlockDevice = require('blockdevice')
var Disk = require('disk')
var NTFS = require('ntfs')
var HFS = require('hfsp')
var ExFAT = require('exfat')

// Create the block device
var device = new BlockDevice({
  path: BlockDevice.getPath( 0 ),
})

// Create the disk
var disk = new Disk( device )

// Add file systems to use for auto-mounting, middleware-style
disk.use( NTFS )
disk.use( HFS )

// Auto-mount known file systems
// Note: would also need to introduce options in `disk.open()`
disk.open({ mount: true }, function( error ) {
  // Note: Iteration should be async, but kept simple here for the sake of demonstration 
  disk.partitions.forEach( function( partition ) {
    if( partition.volume ) {
      // partition.volume = partition.fs.create( partition, options )
      partition.volume.fs.readdir( function( error, ls ) {
        // ...
      })
    }
  })
})

// Don't auto-mount; but create a volume for the partition
disk.open({ mount: false }, function( error ) {
  disk.partitions.forEach( function( partition ) {
    if( partition.volume ) {
      // Manually mount the volume
      partition.volume.mount( function( error, fs ) {
        // ...
      })
    }
  })
})

// Or manually mount a file system on a given partition
disk.mount( disk.partitions[1], ExFAT, function( error, volume ) {
  // partition.volume === volume
  volume.fs.readdir( '/', function( error, ls ) {
    // ...
  })
})

Error: Invalid file descriptor at BlockDevice._read

Hi, do you know what the problem based on this code?
i always get error while reading MBR.
Thanks

var device = new BlockDevice({
    path: BlockDevice.getPath( 1 ),
    mode: 'r+',
})


var disk = new Disk( device );
disk.open( function( error ) {
    if(error) {
        console.log(error);
    }
    else
        console.log(disk);
})

disk.readMBR( function( error, mbr ){
    if(error) {
        console.log(error);
    }
    else {
        console.log(mbr);
    }
})