4 * VMU volume (ie block device) support
6 * Copyright (c) 2009 Nathan Keynes.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
19 #include <glib/gmem.h>
20 #include <glib/gstrfuncs.h>
27 #include "vmu/vmuvol.h"
31 #define VMU_MAX_PARTITIONS 256
32 #define VMU_MAX_BLOCKS 65536 /* Actually slightly less than this, but it'll do */
34 typedef struct vmu_partition {
35 struct vmu_volume_metadata metadata;
41 const gchar *display_name;
42 vmu_partnum_t part_count;
44 struct vmu_partition part[0];
47 /* On-VMU structures, courtesy of Marcus Comstedt */
48 struct vmu_superblock {
62 /* remainder unknown */
71 uint16_t blksize; /* Size in blocks*/
72 uint16_t hdroff; /* Header offset in blocks */
76 #define MD(vmu,ptno) ((vmu)->part[ptno].metadata)
78 #define VMU_BLOCK(vmu,ptno,blkno) (&(vmu)->part[ptno].blocks[(blkno)*VMU_BLOCK_SIZE])
80 #define VMU_FAT_ENTRY(vmu,pt,ent) ((uint16_t *)VMU_BLOCK(vmu, pt, (MD(vmu,pt).fat_block - ((ent)>>8))))[(ent)&0xFF]
82 #define FAT_EMPTY 0xFFFC
83 #define FAT_EOF 0xFFFA
85 static const struct vmu_volume_metadata default_metadata = { 255, 255, 254, 1, 253, 13, 0, 200, 31, 0, 128 };
87 vmu_volume_t vmu_volume_new_default( const gchar *display_name )
89 vmu_volume_t vol = g_malloc0( sizeof(struct vmu_volume) + sizeof(struct vmu_partition) );
92 memcpy( &vol->part[0].metadata, &default_metadata, sizeof(struct vmu_volume_metadata) );
93 vol->part[0].block_count = VMU_DEFAULT_VOL_BLOCKS;
94 vol->part[0].blocks = g_malloc0( VMU_DEFAULT_VOL_BLOCKS * VMU_BLOCK_SIZE );
95 vol->display_name = display_name == NULL ? NULL : g_strdup(display_name);
96 vmu_volume_format( vol, 0, TRUE );
100 void vmu_volume_destroy( vmu_volume_t vol )
106 for( i=0; i<vol->part_count; i++ ) {
107 g_free( vol->part[i].blocks );
108 vol->part[i].blocks = NULL;
110 if( vol->display_name ) {
111 g_free( (char *)vol->display_name );
112 vol->display_name = NULL;
117 void vmu_volume_format( vmu_volume_t vol, vmu_partnum_t pt, gboolean quick )
119 if( pt >= vol->part_count ) {
124 /* Wipe it completely first */
125 memset( vol->part[pt].blocks, 0, (vol->part[pt].block_count) * VMU_BLOCK_SIZE );
128 struct vmu_volume_metadata *meta = &vol->part[pt].metadata;
129 unsigned int fatblkno = meta->fat_block;
130 unsigned int dirblkno = meta->dir_block;
132 /* Write superblock */
133 struct vmu_superblock *super = (struct vmu_superblock *)VMU_BLOCK(vol,pt, meta->super_block);
134 memset( super->magic, 0x55, 16 );
135 memset( &super->colour_flag, 0, 240 ); /* Blank the rest for now */
136 super->fat_block = meta->fat_block;
137 super->fat_size = meta->fat_size;
138 super->dir_block = meta->dir_block;
139 super->user_size = meta->user_size;
141 /* Write file allocation tables */
143 for( j=0; j<meta->fat_size; j++ ) {
144 uint16_t *fat = (uint16_t *)VMU_BLOCK(vol,pt,fatblkno-j);
145 for( i=0; i<256; i++ ) {
150 /* Fill in the system allocations in the FAT */
151 for( i=0; i<meta->fat_size-1; i++ ) {
152 VMU_FAT_ENTRY(vol,pt,fatblkno-i) = fatblkno-i-1;
154 VMU_FAT_ENTRY(vol,pt,fatblkno - i) = FAT_EOF;
155 for( i=0; i<meta->dir_size-1; i++ ) {
156 VMU_FAT_ENTRY(vol,pt,dirblkno-i) = dirblkno-i-1;
158 VMU_FAT_ENTRY(vol,pt,dirblkno-i) = FAT_EOF;
160 /* If quick-format, blank the directory. Otherwise it's already been done */
162 memset( VMU_BLOCK(vol,pt,dirblkno-meta->dir_size+1),
163 0, meta->dir_size * VMU_BLOCK_SIZE );
167 /*************************** File load/save ********************************/
170 * Current file has 1 META chunk for all volume metadata, followed by a
171 * DATA chunk for each partition's block data. The META chunk is required to
172 * occur before any DATA blocks.
173 * Unknown chunks are skipped to allow for forwards compatibility if/when
174 * we add the VMU runtime side of things
177 struct vmu_file_header {
182 uint32_t display_name_len;
183 char display_name[0];
186 struct vmu_chunk_header {
192 gboolean vmu_volume_save( const gchar *filename, vmu_volume_t vol, gboolean create_only )
194 struct vmu_file_header head;
195 struct vmu_chunk_header chunk;
198 gchar *tempfile = get_filename_at(filename, ".XXXXXXXX.vmu");
199 int fd = mkstemps( tempfile, 4 );
205 FILE *f = fdopen( fd, "w+" );
209 memcpy( head.magic, VMU_FILE_MAGIC, 16 );
210 head.version = VMU_FILE_VERSION;
211 head.part_count = vol->part_count;
212 head.display_name_len = vol->display_name == NULL ? 0 : (strlen(vol->display_name)+1);
213 head.head_len = sizeof(head) + head.display_name_len;
214 fwrite( &head, sizeof(head), 1, f );
215 if( vol->display_name != NULL ) {
216 fwrite( vol->display_name, head.display_name_len, 1, f );
220 memcpy( chunk.name, "META", 4 );
221 chunk.length = sizeof(struct vmu_volume_metadata) * vol->part_count;
222 fwrite( &chunk, sizeof(chunk), 1, f );
223 for( i=0; i < vol->part_count; i++ ) {
224 fwrite( &vol->part[i].metadata, sizeof(struct vmu_volume_metadata), 1, f );
227 /* partition DATA chunks */
228 for( i=0; i< vol->part_count; i++ ) {
229 memcpy( chunk.name, "DATA", 4 );
231 if( fwrite( &chunk, sizeof(chunk), 1, f ) != 1 ) goto cleanup;
232 long posn = ftell(f);
233 if( fwrite( &vol->part[i].block_count, sizeof(vol->part[i].block_count), 1, f ) != 1 ) goto cleanup;
234 fwrite_gzip( vol->part[i].blocks, vol->part[i].block_count, VMU_BLOCK_SIZE, f );
236 fseek( f, posn - sizeof(chunk.length), SEEK_SET );
237 chunk.length = end-posn;
238 if( fwrite( &chunk.length, sizeof(chunk.length), 1, f ) != 1 ) goto cleanup;
239 fseek( f, end, SEEK_SET );
243 if( rename(tempfile, filename) != 0 )
258 vmu_volume_t vmu_volume_load( const gchar *filename )
260 struct vmu_file_header head;
261 struct vmu_chunk_header chunk;
265 FILE *f = fopen( filename, "ro" );
267 ERROR( "Unable to open VMU file '%s': %s", filename, strerror(errno) );
271 if( fread( &head, sizeof(head), 1, f ) != 1 ||
272 memcmp(head.magic, VMU_FILE_MAGIC, 16) != 0 ||
273 head.part_count > VMU_MAX_PARTITIONS ||
274 head.head_len < (sizeof(head) + head.display_name_len) ) {
276 ERROR( "Unable to load VMU '%s': bad file header", filename );
280 vol = (vmu_volume_t)g_malloc0( sizeof(struct vmu_volume) + sizeof(struct vmu_partition)*head.part_count );
281 vol->part_count = head.part_count;
283 if( head.display_name_len != 0 ) {
284 vol->display_name = g_malloc( head.display_name_len );
285 fread( (char *)vol->display_name, head.display_name_len, 1, f );
287 fseek( f, head.head_len, SEEK_SET );
289 gboolean have_meta = FALSE;
291 while( !feof(f) && fread( &chunk, sizeof(chunk), 1, f ) == 1 ) {
292 if( memcmp( &chunk.name, "META", 4 ) == 0 ) {
293 if( have_meta || chunk.length != head.part_count * sizeof(struct vmu_volume_metadata) ) {
294 vmu_volume_destroy(vol);
296 ERROR( "Unable to load VMU '%s': bad metadata size (expected %d but was %d)", filename,
297 head.part_count * sizeof(struct vmu_volume_metadata), chunk.length );
300 for( i=0; i<head.part_count; i++ ) {
301 fread( &vol->part[i].metadata, sizeof(struct vmu_volume_metadata), 1, f );
304 } else if( memcmp( &chunk.name, "DATA", 4 ) == 0 ) {
305 uint32_t block_count;
306 fread( &block_count, sizeof(block_count), 1, f );
307 if( next_part >= vol->part_count || block_count >= VMU_MAX_BLOCKS ) {
308 // Too many partitions / blocks
309 vmu_volume_destroy(vol);
311 ERROR( "Unable to load VMU '%s': too large (%d/%d)", filename, next_part, block_count );
314 vol->part[next_part].block_count = block_count;
315 vol->part[next_part].blocks = g_malloc(block_count*VMU_BLOCK_SIZE);
316 fread_gzip(vol->part[next_part].blocks, VMU_BLOCK_SIZE, block_count, f );
319 // else skip unknown block
320 fseek( f, SEEK_CUR, chunk.length );
321 WARN( "Unexpected VMU data chunk: '%4.4s'", chunk.name );
327 if( !have_meta || next_part != vol->part_count ) {
328 vmu_volume_destroy( vol );
335 /*************************** Accessing data ********************************/
336 const char *vmu_volume_get_display_name( vmu_volume_t vol )
338 return vol->display_name;
341 void vmu_volume_set_display_name( vmu_volume_t vol, const gchar *name )
343 if( vol->display_name != NULL ) {
344 g_free( (char *)vol->display_name );
347 vol->display_name = NULL;
349 vol->display_name = g_strdup(name);
353 gboolean vmu_volume_is_dirty( vmu_volume_t vol )
358 gboolean vmu_volume_read_block( vmu_volume_t vol, vmu_partnum_t pt, unsigned int block, unsigned char *out )
360 if( pt >= vol->part_count || block >= vol->part[pt].block_count ) {
364 memcpy( out, VMU_BLOCK(vol,pt,block), VMU_BLOCK_SIZE );
368 gboolean vmu_volume_write_block( vmu_volume_t vol, vmu_partnum_t pt, unsigned int block, unsigned char *in )
370 if( pt >= vol->part_count || block >= vol->part[pt].block_count ) {
373 memcpy( VMU_BLOCK(vol,pt,block), in, VMU_BLOCK_SIZE );
377 gboolean vmu_volume_write_phase( vmu_volume_t vol, vmu_partnum_t pt, unsigned int block, unsigned int phase, unsigned char *in )
379 if( pt >= vol->part_count || block >= vol->part[pt].block_count || phase >= 4 ) {
382 memcpy( VMU_BLOCK(vol,pt,block) + (phase*128), in, VMU_BLOCK_SIZE/4 );
386 const struct vmu_volume_metadata *vmu_volume_get_metadata( vmu_volume_t vol, vmu_partnum_t partition )
388 if( partition >= vol->part_count ) {
391 return &vol->part[partition].metadata;
.