nkeynes@26: /**
nkeynes@586:  * $Id$
nkeynes@26:  * Central switchboard for the system. This pulls all the individual modules
nkeynes@26:  * together into some kind of coherent structure. This is also where you'd
nkeynes@26:  * add Naomi support, if I ever get a board to play with...
nkeynes@26:  *
nkeynes@26:  * Copyright (c) 2005 Nathan Keynes.
nkeynes@26:  *
nkeynes@26:  * This program is free software; you can redistribute it and/or modify
nkeynes@26:  * it under the terms of the GNU General Public License as published by
nkeynes@26:  * the Free Software Foundation; either version 2 of the License, or
nkeynes@26:  * (at your option) any later version.
nkeynes@26:  *
nkeynes@26:  * This program is distributed in the hope that it will be useful,
nkeynes@26:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
nkeynes@26:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
nkeynes@26:  * GNU General Public License for more details.
nkeynes@26:  */
nkeynes@26: 
nkeynes@18: #include <errno.h>
nkeynes@543: #include <glib.h>
nkeynes@669: #include "lxdream.h"
nkeynes@740: #include "dream.h"
nkeynes@2: #include "mem.h"
nkeynes@669: #include "dreamcast.h"
nkeynes@669: #include "asic.h"
nkeynes@669: #include "syscall.h"
nkeynes@669: #include "gui.h"
nkeynes@11: #include "aica/aica.h"
nkeynes@25: #include "gdrom/ide.h"
nkeynes@25: #include "maple/maple.h"
nkeynes@669: #include "sh4/sh4.h"
nkeynes@740: #include "sh4/sh4core.h"
nkeynes@15: 
nkeynes@26: /**
nkeynes@26:  * Current state of the DC virtual machine
nkeynes@26:  */
nkeynes@543: typedef enum { STATE_UNINIT=0, STATE_RUNNING, 
nkeynes@736:                STATE_STOPPING, STATE_STOPPED } dreamcast_state_t;
nkeynes@736:     
nkeynes@543: static volatile dreamcast_state_t dreamcast_state = STATE_UNINIT;
nkeynes@543: static gboolean dreamcast_has_bios = FALSE;
nkeynes@742: static gboolean dreamcast_has_flash = FALSE;
nkeynes@689: static gboolean dreamcast_exit_on_stop = FALSE;
nkeynes@543: static gchar *dreamcast_program_name = NULL;
nkeynes@543: static sh4addr_t dreamcast_entry_point = 0xA0000000;
nkeynes@26: static uint32_t timeslice_length = DEFAULT_TIMESLICE_LENGTH;
nkeynes@689: static uint64_t run_time_nanosecs = 0;
nkeynes@2: 
nkeynes@15: #define MAX_MODULES 32
nkeynes@15: static int num_modules = 0;
nkeynes@16: dreamcast_module_t modules[MAX_MODULES];
nkeynes@15: 
nkeynes@16: /**
nkeynes@35:  * The unknown module is used for logging files without an actual module
nkeynes@35:  * declaration
nkeynes@35:  */
nkeynes@35: struct dreamcast_module unknown_module = { "****", NULL, NULL, NULL, NULL, 
nkeynes@736:         NULL, NULL, NULL };
nkeynes@35: 
nkeynes@929: extern struct mem_region_fn mem_region_sdram;
nkeynes@929: extern struct mem_region_fn mem_region_vram32;
nkeynes@929: extern struct mem_region_fn mem_region_vram64;
nkeynes@929: extern struct mem_region_fn mem_region_audioram;
nkeynes@929: extern struct mem_region_fn mem_region_flashram;
nkeynes@929: extern struct mem_region_fn mem_region_bootrom;
nkeynes@929: 
nkeynes@35: /**
nkeynes@16:  * This function is responsible for defining how all the pieces of the
nkeynes@26:  * dreamcast actually fit together. 
nkeynes@16:  *
nkeynes@16:  * Note currently the locations of the various MMIO pages are hard coded in
nkeynes@16:  * the MMIO definitions - they should probably be moved here.
nkeynes@16:  */
nkeynes@15: void dreamcast_configure( )
nkeynes@15: {
nkeynes@825:     const char *bios_path = lxdream_get_config_value(CONFIG_BIOS_PATH);
nkeynes@825:     const char *flash_path = lxdream_get_config_value(CONFIG_FLASH_PATH);
nkeynes@825:     
nkeynes@265:     dreamcast_register_module( &eventq_module );
nkeynes@16:     /* Register the memory framework */
nkeynes@15:     dreamcast_register_module( &mem_module );
nkeynes@16: 
nkeynes@16:     /* Setup standard memory map */
nkeynes@929:     mem_create_repeating_ram_region( 0x0C000000, 16 MB, MEM_REGION_MAIN, &mem_region_sdram, 0x01000000, 0x0F000000 );
nkeynes@929:     mem_create_ram_region( 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram );
nkeynes@929:     mem_create_ram_region( 0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH, NULL );
nkeynes@929:     mem_create_ram_region( 0x05000000, 8 MB, MEM_REGION_VIDEO, &mem_region_vram32 );
nkeynes@929:     dreamcast_has_bios = mem_load_rom( bios_path, 0x00000000, 0x00200000, 0x89f2b1a1, MEM_REGION_BIOS, &mem_region_bootrom );
nkeynes@929:     mem_create_ram_region( 0x00200000, 0x00020000, MEM_REGION_FLASH, &mem_region_flashram );
nkeynes@825:     if( flash_path != NULL && flash_path[0] != '\0' ) {
nkeynes@825:         mem_load_block( flash_path, 0x00200000, 0x00020000 );
nkeynes@825:     }
nkeynes@742:     dreamcast_has_flash = TRUE;
nkeynes@16: 
nkeynes@16:     /* Load in the rest of the core modules */
nkeynes@15:     dreamcast_register_module( &sh4_module );
nkeynes@15:     dreamcast_register_module( &asic_module );
nkeynes@15:     dreamcast_register_module( &pvr2_module );
nkeynes@15:     dreamcast_register_module( &aica_module );
nkeynes@15:     dreamcast_register_module( &maple_module );
nkeynes@15:     dreamcast_register_module( &ide_module );
nkeynes@15: }
nkeynes@15: 
nkeynes@461: void dreamcast_config_changed(void)
nkeynes@461: {
nkeynes@825:     const char *bios_path = lxdream_get_config_value(CONFIG_BIOS_PATH);
nkeynes@825:     const char *flash_path = lxdream_get_config_value(CONFIG_FLASH_PATH);
nkeynes@929:     dreamcast_has_bios = mem_load_rom( bios_path, 0x00000000, 0x00200000, 0x89f2b1a1, MEM_REGION_BIOS, &mem_region_bootrom );
nkeynes@825:     if( flash_path != NULL && flash_path[0] != '\0' ) {
nkeynes@825:         mem_load_block( flash_path, 0x00200000, 0x00020000 );
nkeynes@825:     }
nkeynes@461: }
nkeynes@461: 
nkeynes@277: void dreamcast_save_flash()
nkeynes@277: {
nkeynes@742:     if( dreamcast_has_flash ) {
nkeynes@742:         const char *file = lxdream_get_config_value(CONFIG_FLASH_PATH);
nkeynes@742:         mem_save_block( file, 0x00200000, 0x00020000 );
nkeynes@742:     }
nkeynes@277: }
nkeynes@277: 
nkeynes@71: /**
nkeynes@71:  * Constructs a system configuration for the AICA in standalone mode,
nkeynes@71:  * ie sound chip only.
nkeynes@71:  */
nkeynes@71: void dreamcast_configure_aica_only( )
nkeynes@71: {
nkeynes@71:     dreamcast_register_module( &mem_module );
nkeynes@929:     mem_create_ram_region( 0x00800000, 2 MB, MEM_REGION_AUDIO, &mem_region_audioram );
nkeynes@929:     mem_create_ram_region( 0x00703000, 8 KB, MEM_REGION_AUDIO_SCRATCH, NULL );
nkeynes@71:     dreamcast_register_module( &aica_module );
nkeynes@89:     aica_enable();
nkeynes@71:     dreamcast_state = STATE_STOPPED;
nkeynes@71: }
nkeynes@71: 
nkeynes@15: void dreamcast_register_module( dreamcast_module_t module ) 
nkeynes@15: {
nkeynes@15:     modules[num_modules++] = module;
nkeynes@16:     if( module->init != NULL )
nkeynes@736:         module->init();
nkeynes@15: }
nkeynes@15: 
nkeynes@689: void dreamcast_set_run_time( uint32_t secs, uint32_t nanosecs )
nkeynes@689: {
nkeynes@689:     run_time_nanosecs = (((uint64_t)secs) * 1000000000) + nanosecs;
nkeynes@689: }
nkeynes@689: 
nkeynes@689: void dreamcast_set_exit_on_stop( gboolean flag )
nkeynes@689: {
nkeynes@689:     dreamcast_exit_on_stop = flag;
nkeynes@689: }
nkeynes@15: 
nkeynes@2: void dreamcast_init( void )
nkeynes@2: {
nkeynes@15:     dreamcast_configure();
nkeynes@23:     dreamcast_state = STATE_STOPPED;
nkeynes@2: }
nkeynes@2: 
nkeynes@2: void dreamcast_reset( void )
nkeynes@2: {
nkeynes@766:     sh4_core_exit(CORE_EXIT_SYSRESET);
nkeynes@15:     int i;
nkeynes@15:     for( i=0; i<num_modules; i++ ) {
nkeynes@736:         if( modules[i]->reset != NULL )
nkeynes@736:             modules[i]->reset();
nkeynes@15:     }
nkeynes@2: }
nkeynes@2: 
nkeynes@23: void dreamcast_run( void )
nkeynes@15: {
nkeynes@15:     int i;
nkeynes@889:     
nkeynes@889:     if( !dreamcast_can_run() ) {
nkeynes@889:         ERROR(_("No program is loaded, and no BIOS is configured (required to boot a CD image). To continue, either load a binary program, or set the path to your BIOS file in the Path Preferences"));
nkeynes@889:         return;
nkeynes@889:     }
nkeynes@889:     
nkeynes@23:     if( dreamcast_state != STATE_RUNNING ) {
nkeynes@689:         for( i=0; i<num_modules; i++ ) {
nkeynes@689:             if( modules[i]->start != NULL )
nkeynes@689:                 modules[i]->start();
nkeynes@689:         }
nkeynes@15:     }
nkeynes@839:     
nkeynes@839:     if( maple_should_grab() ) {
nkeynes@839:         gui_set_use_grab(TRUE);
nkeynes@839:     }
nkeynes@736: 
nkeynes@23:     dreamcast_state = STATE_RUNNING;
nkeynes@736: 
nkeynes@689:     if( run_time_nanosecs != 0 ) {
nkeynes@689:         while( dreamcast_state == STATE_RUNNING ) {
nkeynes@689:             uint32_t time_to_run = timeslice_length;
nkeynes@689:             if( run_time_nanosecs < time_to_run ) {
nkeynes@689:                 time_to_run = (uint32_t)run_time_nanosecs;
nkeynes@689:             }
nkeynes@736: 
nkeynes@689:             for( i=0; i<num_modules; i++ ) {
nkeynes@689:                 if( modules[i]->run_time_slice != NULL )
nkeynes@689:                     time_to_run = modules[i]->run_time_slice( time_to_run );
nkeynes@689:             }
nkeynes@736: 
nkeynes@689:             if( run_time_nanosecs > time_to_run ) {
nkeynes@689:                 run_time_nanosecs -= time_to_run;
nkeynes@689:             } else {
nkeynes@689:                 run_time_nanosecs = 0; // Finished
nkeynes@689:                 break;
nkeynes@689:             }
nkeynes@689:         }
nkeynes@689:     } else {
nkeynes@689:         while( dreamcast_state == STATE_RUNNING ) {
nkeynes@689:             int time_to_run = timeslice_length;
nkeynes@689:             for( i=0; i<num_modules; i++ ) {
nkeynes@689:                 if( modules[i]->run_time_slice != NULL )
nkeynes@689:                     time_to_run = modules[i]->run_time_slice( time_to_run );
nkeynes@689:             }
nkeynes@23: 
nkeynes@689:         }
nkeynes@23:     }
nkeynes@23: 
nkeynes@839:     gui_set_use_grab(FALSE);
nkeynes@839:     
nkeynes@15:     for( i=0; i<num_modules; i++ ) {
nkeynes@689:         if( modules[i]->stop != NULL )
nkeynes@689:             modules[i]->stop();
nkeynes@15:     }
nkeynes@23:     dreamcast_state = STATE_STOPPED;
nkeynes@736: 
nkeynes@689:     if( dreamcast_exit_on_stop ) {
nkeynes@689:         dreamcast_shutdown();
nkeynes@689:         exit(0);
nkeynes@372:     }
nkeynes@372: }
nkeynes@372: 
nkeynes@23: void dreamcast_stop( void )
nkeynes@23: {
nkeynes@740:     sh4_core_exit(CORE_EXIT_HALT); // returns only if not inside SH4 core
nkeynes@23:     if( dreamcast_state == STATE_RUNNING )
nkeynes@736:         dreamcast_state = STATE_STOPPING;
nkeynes@23: }
nkeynes@17: 
nkeynes@277: void dreamcast_shutdown()
nkeynes@277: {
nkeynes@727:     // Don't do a dreamcast_stop - if we're calling this out of SH4 code,
nkeynes@727:     // it's a shutdown-and-quit event
nkeynes@727:     if( dreamcast_state == STATE_RUNNING )
nkeynes@727:         dreamcast_state = STATE_STOPPING;
nkeynes@277:     dreamcast_save_flash();
nkeynes@671: #ifdef ENABLE_SH4STATS
nkeynes@671:     sh4_stats_print(stdout);
nkeynes@671: #endif
nkeynes@929:     print_sh4mem_stats();
nkeynes@277: }
nkeynes@277: 
nkeynes@543: void dreamcast_program_loaded( const gchar *name, sh4addr_t entry_point )
nkeynes@543: {
nkeynes@543:     if( dreamcast_program_name != NULL ) {
nkeynes@543:         g_free(dreamcast_program_name);
nkeynes@543:     }
nkeynes@543:     dreamcast_program_name = g_strdup(name);
nkeynes@543:     dreamcast_entry_point = entry_point;
nkeynes@543:     sh4_set_pc(entry_point);
nkeynes@586:     bios_install();
nkeynes@543:     dcload_install();
nkeynes@543:     gui_update_state();
nkeynes@543: }
nkeynes@543: 
nkeynes@26: gboolean dreamcast_is_running( void )
nkeynes@26: {
nkeynes@26:     return dreamcast_state == STATE_RUNNING;
nkeynes@26: }
nkeynes@26: 
nkeynes@543: gboolean dreamcast_can_run(void)
nkeynes@543: {
nkeynes@543:     return dreamcast_state != STATE_UNINIT &&
nkeynes@736:     (dreamcast_has_bios || dreamcast_program_name != NULL);
nkeynes@543: }
nkeynes@543: 
nkeynes@26: /********************************* Save States *****************************/
nkeynes@26: 
nkeynes@26: struct save_state_header {
nkeynes@26:     char magic[16];
nkeynes@26:     uint32_t version;
nkeynes@26:     uint32_t module_count;
nkeynes@26: };
nkeynes@26: 
nkeynes@477: struct chunk_header {
nkeynes@477:     char marker[4]; /* Always BLCK */
nkeynes@477:     char name[8]; /* Block (module) name */
nkeynes@477:     uint32_t block_length;
nkeynes@477: };
nkeynes@477: 
nkeynes@477: /**
nkeynes@477:  * Check the save state header to ensure that it is a valid, supported
nkeynes@477:  * file. 
nkeynes@477:  * @return the number of blocks following, or 0 if the file is invalid.
nkeynes@477:  */
nkeynes@891: int dreamcast_read_save_state_header( FILE *f, char *error, int errorlen )
nkeynes@477: {
nkeynes@477:     struct save_state_header header;
nkeynes@477:     if( fread( &header, sizeof(header), 1, f ) != 1 ) {
nkeynes@736:         return 0;
nkeynes@477:     }
nkeynes@477:     if( strncmp( header.magic, DREAMCAST_SAVE_MAGIC, 16 ) != 0 ) {
nkeynes@891:     	if( error != NULL )
nkeynes@891:     		snprintf( error, errorlen, _("File is not a %s save state"), APP_NAME );
nkeynes@736:         return 0;
nkeynes@477:     }
nkeynes@477:     if( header.version != DREAMCAST_SAVE_VERSION ) {
nkeynes@891:     	if( error != NULL )
nkeynes@892:     		snprintf( error, errorlen, _("Unsupported %s save state version"), APP_NAME );
nkeynes@736:         return 0;
nkeynes@477:     }
nkeynes@477:     if( header.module_count > MAX_MODULES ) {
nkeynes@891:     	if( error != NULL )
nkeynes@891:     		snprintf( error, errorlen, _("%s save state is corrupted (bad module count)"), APP_NAME );
nkeynes@736:         return 0;
nkeynes@477:     }
nkeynes@477:     return header.module_count;
nkeynes@477: }
nkeynes@477: 
nkeynes@477: int dreamcast_write_chunk_header( const gchar *name, uint32_t length, FILE *f )
nkeynes@477: {
nkeynes@477:     struct chunk_header head;
nkeynes@477: 
nkeynes@477:     memcpy( head.marker, "BLCK", 4 );
nkeynes@477:     memset( head.name, 0, 8 );
nkeynes@477:     memcpy( head.name, name, strlen(name) );
nkeynes@477:     head.block_length = length;
nkeynes@477:     return fwrite( &head, sizeof(head), 1, f );
nkeynes@477: }
nkeynes@477: 
nkeynes@477: 
nkeynes@477: frame_buffer_t dreamcast_load_preview( const gchar *filename )
nkeynes@477: {
nkeynes@477:     int i;
nkeynes@477:     FILE *f = fopen( filename, "r" );
nkeynes@477:     if( f == NULL ) return NULL;
nkeynes@736: 
nkeynes@891:     int module_count = dreamcast_read_save_state_header(f, NULL, 0);
nkeynes@477:     if( module_count <= 0 ) {
nkeynes@736:         fclose(f);
nkeynes@736:         return NULL;
nkeynes@477:     }
nkeynes@477:     for( i=0; i<module_count; i++ ) {
nkeynes@736:         struct chunk_header head;
nkeynes@736:         if( fread( &head, sizeof(head), 1, f ) != 1 ) {
nkeynes@736:             fclose(f);
nkeynes@736:             return NULL;
nkeynes@736:         }
nkeynes@736:         if( memcmp("BLCK", head.marker, 4) != 0 ) {
nkeynes@736:             fclose(f);
nkeynes@736:             return NULL;
nkeynes@736:         }
nkeynes@477: 
nkeynes@736:         if( strcmp("PVR2", head.name) == 0 ) {
nkeynes@736:             uint32_t buf_count;
nkeynes@736:             int has_front;
nkeynes@736:             fread( &buf_count, sizeof(buf_count), 1, f );
nkeynes@736:             fread( &has_front, sizeof(has_front), 1, f );
nkeynes@736:             if( buf_count != 0 && has_front ) {
nkeynes@736:                 frame_buffer_t result = read_png_from_stream(f);
nkeynes@736:                 fclose(f);
nkeynes@736:                 return result;
nkeynes@736:             }
nkeynes@736:             break;
nkeynes@736:         } else {
nkeynes@736:             fseek( f, head.block_length, SEEK_CUR );
nkeynes@736:         }
nkeynes@477:     }
nkeynes@477:     return NULL;
nkeynes@477: }
nkeynes@477: 
nkeynes@18: int dreamcast_load_state( const gchar *filename )
nkeynes@15: {
nkeynes@17:     int i,j;
nkeynes@477:     int module_count;
nkeynes@891:     char error[128];
nkeynes@17:     int have_read[MAX_MODULES];
nkeynes@18: 
nkeynes@477:     FILE *f = fopen( filename, "r" );
nkeynes@18:     if( f == NULL ) return errno;
nkeynes@15: 
nkeynes@891:     module_count = dreamcast_read_save_state_header(f, error, sizeof(error));
nkeynes@477:     if( module_count <= 0 ) {
nkeynes@891:     	ERROR( error );
nkeynes@736:         fclose(f);
nkeynes@736:         return 1;
nkeynes@15:     }
nkeynes@477: 
nkeynes@17:     for( i=0; i<MAX_MODULES; i++ ) {
nkeynes@736:         have_read[i] = 0;
nkeynes@15:     }
nkeynes@15: 
nkeynes@477:     for( i=0; i<module_count; i++ ) {
nkeynes@736:         struct chunk_header chunk;
nkeynes@736:         fread( &chunk, sizeof(chunk), 1, f );
nkeynes@736:         if( strncmp(chunk.marker, "BLCK", 4) != 0 ) {
nkeynes@736:             ERROR( "%s save state is corrupted (missing block header %d)", APP_NAME, i );
nkeynes@736:             fclose(f);
nkeynes@736:             return 2;
nkeynes@736:         }
nkeynes@736: 
nkeynes@736:         /* Find the matching module by name */
nkeynes@736:         for( j=0; j<num_modules; j++ ) {
nkeynes@736:             if( strcmp(modules[j]->name,chunk.name) == 0 ) {
nkeynes@736:                 have_read[j] = 1;
nkeynes@736:                 if( modules[j]->load == NULL ) {
nkeynes@736:                     ERROR( "%s save state is corrupted (no loader for %s)", APP_NAME, modules[j]->name );
nkeynes@736:                     fclose(f);
nkeynes@736:                     return 2;
nkeynes@736:                 } else if( modules[j]->load(f) != 0 ) {
nkeynes@736:                     ERROR( "%s save state is corrupted (%s failed)", APP_NAME, modules[j]->name );
nkeynes@736:                     fclose(f);
nkeynes@736:                     return 2;
nkeynes@736:                 }
nkeynes@736:                 break;
nkeynes@736:             }
nkeynes@736:         }
nkeynes@736:         if( j == num_modules ) {
nkeynes@736:             fclose(f);
nkeynes@736:             ERROR( "%s save state contains unrecognized section", APP_NAME );
nkeynes@736:             return 2;
nkeynes@736:         }
nkeynes@17:     }
nkeynes@736: 
nkeynes@17:     /* Any modules that we didn't load - reset to the default state.
nkeynes@17:      * (ie it's not an error to skip a module if you don't actually
nkeynes@17:      * care about its state).
nkeynes@17:      */
nkeynes@17:     for( j=0; j<num_modules; j++ ) {
nkeynes@736:         if( have_read[j] == 0 && modules[j]->reset != NULL ) {
nkeynes@736:             modules[j]->reset();
nkeynes@736:         }
nkeynes@15:     }
nkeynes@18:     fclose(f);
nkeynes@18:     INFO( "Save state read from %s", filename );
nkeynes@422:     return 0;
nkeynes@15: }
nkeynes@15: 
nkeynes@18: int dreamcast_save_state( const gchar *filename )
nkeynes@15: {
nkeynes@15:     int i;
nkeynes@18:     FILE *f;
nkeynes@15:     struct save_state_header header;
nkeynes@736: 
nkeynes@18:     f = fopen( filename, "w" );
nkeynes@18:     if( f == NULL )
nkeynes@736:         return errno;
nkeynes@15:     strcpy( header.magic, DREAMCAST_SAVE_MAGIC );
nkeynes@15:     header.version = DREAMCAST_SAVE_VERSION;
nkeynes@18:     header.module_count = 0;
nkeynes@18: 
nkeynes@18:     for( i=0; i<num_modules; i++ ) {
nkeynes@736:         if( modules[i]->save != NULL )
nkeynes@736:             header.module_count++;
nkeynes@18:     }
nkeynes@15:     fwrite( &header, sizeof(header), 1, f );
nkeynes@15:     for( i=0; i<num_modules; i++ ) {
nkeynes@736:         if( modules[i]->save != NULL ) {
nkeynes@736:             uint32_t blocklen, posn1, posn2;
nkeynes@736:             dreamcast_write_chunk_header( modules[i]->name, 0, f );
nkeynes@736:             posn1 = ftell(f);
nkeynes@736:             modules[i]->save(f);
nkeynes@736:             posn2 = ftell(f);
nkeynes@736:             blocklen = posn2 - posn1;
nkeynes@736:             fseek( f, posn1-4, SEEK_SET );
nkeynes@736:             fwrite( &blocklen, sizeof(blocklen), 1, f );
nkeynes@736:             fseek( f, posn2, SEEK_SET );
nkeynes@736:         }
nkeynes@15:     }
nkeynes@18:     fclose( f );
nkeynes@18:     INFO( "Save state written to %s", filename );
nkeynes@422:     return 0;
nkeynes@15: }
nkeynes@15: