src/MacOSX/main_macosx.mm

/*
 *  $Id: main_macosx.mm,v 1.19 2008/01/01 09:40:32 gbeauche Exp $
 *
 *  main_macosx.mm -    Startup code for MacOS X
 *                                              Based (in a small way) on the default main.m,
                                                and on Basilisk's main_unix.cpp
 *
 *  Basilisk II (C) 1997-2008 Christian Bauer
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#import <AppKit/AppKit.h>
#undef check

#define PTHREADS        // Why is this here?
#include "sysdeps.h"

#ifdef HAVE_PTHREADS
# include <pthread.h>
#endif

#if REAL_ADDRESSING || DIRECT_ADDRESSING
# include <sys/mman.h>
#endif

#include <string>
using std::string;

#include "cpu_emulation.h"
#include "macos_util_macosx.h"
#include "main.h"
#include "prefs.h"
#include "prefs_editor.h"
#include "rom_patches.h"
#include "sigsegv.h"
#include "sys.h"
#include "user_strings.h"
#include "version.h"
#include "video.h"
#include "vm_alloc.h"
#include "xpram.h"

#if USE_JIT
extern void flush_icache_range(uint8 *start, uint32 size);  // from compemu_support.cpp
#endif

#ifdef ENABLE_MON
# include "mon.h"
#endif

#define DEBUG 0
#include "debug.h"


#include "main_macosx.h"                // To bridge between main() and misc. classes


// Constants
const char ROM_FILE_NAME[] = "ROM";
const int SCRATCH_MEM_SIZE = 0x10000;   // Size of scratch memory area


static char *bundle = NULL;             // If in an OS X application bundle, its path


// CPU and FPU type, addressing mode
int CPUType;
bool CPUIs68060;
int FPUType;
bool TwentyFourBitAddressing;


// Global variables

#ifdef HAVE_PTHREADS

static pthread_mutex_t intflag_lock = PTHREAD_MUTEX_INITIALIZER;        // Mutex to protect InterruptFlags
#define LOCK_INTFLAGS pthread_mutex_lock(&intflag_lock)
#define UNLOCK_INTFLAGS pthread_mutex_unlock(&intflag_lock)

#else

#define LOCK_INTFLAGS
#define UNLOCK_INTFLAGS

#endif

#if USE_SCRATCHMEM_SUBTERFUGE
uint8 *ScratchMem = NULL;                       // Scratch memory for Mac ROM writes
#endif

#ifdef ENABLE_MON
static struct sigaction sigint_sa;      // sigaction for SIGINT handler
static void sigint_handler(...);
#endif

#if REAL_ADDRESSING
static bool lm_area_mapped = false;     // Flag: Low Memory area mmap()ped
#endif


/*
 *  Helpers to map memory that can be accessed from the Mac side
 */

// NOTE: VM_MAP_32BIT is only used when compiling a 64-bit JIT on specific platforms
void *vm_acquire_mac(size_t size)
{
        return vm_acquire(size, VM_MAP_DEFAULT | VM_MAP_32BIT);
}

static int vm_acquire_mac_fixed(void *addr, size_t size)
{
        return vm_acquire_fixed(addr, size, VM_MAP_DEFAULT | VM_MAP_32BIT);
}


/*
 *  SIGSEGV handler
 */

static sigsegv_return_t sigsegv_handler(sigsegv_info_t *sip)
{
        const uintptr fault_address = (uintptr)sigsegv_get_fault_address(sip);
#if ENABLE_VOSF
        // Handle screen fault
        extern bool Screen_fault_handler(sigsegv_info_t *sip);
        if (Screen_fault_handler(sip))
                return SIGSEGV_RETURN_SUCCESS;
#endif

#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
        // Ignore writes to ROM
        if (((uintptr)fault_address - (uintptr)ROMBaseHost) < ROMSize)
                return SIGSEGV_RETURN_SKIP_INSTRUCTION;

        // Ignore all other faults, if requested
        if (PrefsFindBool("ignoresegv"))
                return SIGSEGV_RETURN_SKIP_INSTRUCTION;
#endif

        return SIGSEGV_RETURN_FAILURE;
}


/*
 *  Dump state when everything went wrong after a SEGV
 */

static void sigsegv_dump_state(sigsegv_info_t *sip)
{
        const sigsegv_address_t fault_address = sigsegv_get_fault_address(sip);
        const sigsegv_address_t fault_instruction = sigsegv_get_fault_instruction_address(sip);
        fprintf(stderr, "Caught SIGSEGV at address %p", fault_address);
        if (fault_instruction != SIGSEGV_INVALID_ADDRESS)
                fprintf(stderr, " [IP=%p]", fault_instruction);
        fprintf(stderr, "\n");
        uaecptr nextpc;
        extern void m68k_dumpstate(uaecptr *nextpc);
        m68k_dumpstate(&nextpc);
#if USE_JIT && JIT_DEBUG
        extern void compiler_dumpstate(void);
        compiler_dumpstate();
#endif
        VideoQuitFullScreen();
#ifdef ENABLE_MON
        char *arg[4] = {"mon", "-m", "-r", NULL};
        mon(3, arg);
#endif
        QuitEmulator();
}


/*
 * Screen fault handler
 */

bool Screen_fault_handler(sigsegv_info_t *sip)
{
        return true;
}


/*
 *  Main program
 */

static void usage(const char *prg_name)
{
        printf("Usage: %s [OPTION...]\n", prg_name);
        printf("\nUnix options:\n");
        printf("  --help\n    display this usage message\n");
        printf("  --config FILE\n    read/write configuration from/to FILE\n");
        printf("  --break ADDRESS\n    set ROM breakpoint\n");
        printf("  --rominfo\n    dump ROM information\n");
        LoadPrefs(); // read the prefs file so PrefsPrintUsage() will print the correct default values
        PrefsPrintUsage();
        exit(0);
}

int main(int argc, char **argv)
{
        // Initialize variables
        RAMBaseHost = NULL;
        ROMBaseHost = NULL;
        srand(time(NULL));
        tzset();

        // Print some info
        printf(GetString(STR_ABOUT_TEXT1), VERSION_MAJOR, VERSION_MINOR);
        printf(" %s\n", GetString(STR_ABOUT_TEXT2));

        // Parse command line arguments
        for (int i=1; i<argc; i++) {
                if (strcmp(argv[i], "--help") == 0) {
                        usage(argv[0]);
                } else if (strncmp(argv[i], "-psn_", 5) == 0) {// OS X process identifier
                        i++;
                } else if (strcmp(argv[i], "--break") == 0) {
                        i++;
                        if (i < argc)
                                ROMBreakpoint = strtol(argv[i], NULL, 0);
                } else if (strcmp(argv[i], "--config") == 0) {
                        argv[i++] = NULL;
                        if (i < argc) {
                                extern string UserPrefsPath; // from prefs_unix.cpp
                                UserPrefsPath = argv[i];
                                argv[i] = NULL;
                        }
                } else if (strcmp(argv[i], "--rominfo") == 0) {
                        PrintROMInfo = true;
                } else if (argv[i][0] == '-') {
                        fprintf(stderr, "Unrecognized option '%s'\n", argv[i]);
                        usage(argv[0]);
                }
        }

        // Read preferences
        PrefsInit(argc, argv);

        // Init system routines
        SysInit();

        // Set the current directory somewhere useful.
        // Handy for storing the ROM file
        bundle = strstr(argv[0], "BasiliskII.app/Contents/MacOS/BasiliskII");
        if (bundle)
        {
                while (*bundle != '/')
                        ++bundle;

                *bundle = 0;  // Throw away Contents/... on end of argv[0]
                bundle = argv[0];

                chdir(bundle);
        }

        // Open display, attach to window server,
        // load pre-instantiated classes from MainMenu.nib, start run loop
        int i = NSApplicationMain(argc, (const char **)argv);
        // We currently never get past here, because QuitEmulator() does an exit()

        // Exit system routines
        SysExit();

        // Exit preferences
        PrefsExit();

        return i;
}

#define QuitEmulator()  { QuitEmuNoExit() ; return NO; }

bool InitEmulator (void)
{
        char str[256];


        // Install the handler for SIGSEGV
        if (!sigsegv_install_handler(sigsegv_handler)) {
                sprintf(str, GetString(STR_SIG_INSTALL_ERR), "SIGSEGV", strerror(errno));
                ErrorAlert(str);
                QuitEmulator();
        }

        // Register dump state function when we got mad after a segfault
        sigsegv_set_dump_state(sigsegv_dump_state);

        // Read RAM size
        RAMSize = PrefsFindInt32("ramsize") & 0xfff00000;       // Round down to 1MB boundary
        if (RAMSize < 1024*1024) {
                WarningAlert(GetString(STR_SMALL_RAM_WARN));
                RAMSize = 1024*1024;
        }
        if (RAMSize > 1023*1024*1024)                                           // Cap to 1023MB (APD crashes at 1GB)
                RAMSize = 1023*1024*1024;

#if REAL_ADDRESSING || DIRECT_ADDRESSING
        RAMSize = RAMSize & -getpagesize();                                     // Round down to page boundary
#endif
        
        // Initialize VM system
        vm_init();

#if REAL_ADDRESSING
        // Flag: RAM and ROM are contigously allocated from address 0
        bool memory_mapped_from_zero = false;

        // Make sure to map RAM & ROM at address 0 only on platforms that
        // supports linker scripts to relocate the Basilisk II executable
        // above 0x70000000
#if HAVE_LINKER_SCRIPT
        const bool can_map_all_memory = true;
#else
        const bool can_map_all_memory = false;
#endif
        
        // Try to allocate all memory from 0x0000, if it is not known to crash
        if (can_map_all_memory && (vm_acquire_mac_fixed(0, RAMSize + 0x100000) == 0)) {
                D(bug("Could allocate RAM and ROM from 0x0000\n"));
                memory_mapped_from_zero = true;
        }
        
#ifndef PAGEZERO_HACK
        // Otherwise, just create the Low Memory area (0x0000..0x2000)
        else if (vm_acquire_mac_fixed(0, 0x2000) == 0) {
                D(bug("Could allocate the Low Memory globals\n"));
                lm_area_mapped = true;
        }
        
        // Exit on failure
        else {
                sprintf(str, GetString(STR_LOW_MEM_MMAP_ERR), strerror(errno));
                ErrorAlert(str);
                QuitEmulator();
        }
#endif
#else
        *str = 0;               // Eliminate unused variable warning
#endif /* REAL_ADDRESSING */

        // Create areas for Mac RAM and ROM
#if REAL_ADDRESSING
        if (memory_mapped_from_zero) {
                RAMBaseHost = (uint8 *)0;
                ROMBaseHost = RAMBaseHost + RAMSize;
        }
        else
#endif
        {
                uint8 *ram_rom_area = (uint8 *)vm_acquire_mac(RAMSize + 0x100000);
                if (ram_rom_area == VM_MAP_FAILED) { 
                        ErrorAlert(STR_NO_MEM_ERR);
                        QuitEmulator();
                }
                RAMBaseHost = ram_rom_area;
                ROMBaseHost = RAMBaseHost + RAMSize;
        }

#if USE_SCRATCHMEM_SUBTERFUGE
        // Allocate scratch memory
        ScratchMem = (uint8 *)vm_acquire_mac(SCRATCH_MEM_SIZE);
        if (ScratchMem == VM_MAP_FAILED) {
                ErrorAlert(STR_NO_MEM_ERR);
                QuitEmulator();
        }
        ScratchMem += SCRATCH_MEM_SIZE/2;       // ScratchMem points to middle of block
#endif

#if DIRECT_ADDRESSING
        // RAMBaseMac shall always be zero
        MEMBaseDiff = (uintptr)RAMBaseHost;
        RAMBaseMac = 0;
        ROMBaseMac = Host2MacAddr(ROMBaseHost);
#endif
#if REAL_ADDRESSING
        RAMBaseMac = Host2MacAddr(RAMBaseHost);
        ROMBaseMac = Host2MacAddr(ROMBaseHost);
#endif
        D(bug("Mac RAM starts at %p (%08x)\n", RAMBaseHost, RAMBaseMac));
        D(bug("Mac ROM starts at %p (%08x)\n", ROMBaseHost, ROMBaseMac));
        
        // Get rom file path from preferences
        const char *rom_path = PrefsFindString("rom");
        if ( ! rom_path )
          if ( bundle )
                WarningAlert("No rom pathname set. Trying BasiliskII.app/ROM");
          else
                WarningAlert("No rom pathname set. Trying ./ROM");

        // Load Mac ROM
        int rom_fd = open(rom_path ? rom_path : ROM_FILE_NAME, O_RDONLY);
        if (rom_fd < 0) {
                ErrorAlert(STR_NO_ROM_FILE_ERR);
                QuitEmulator();
        }
        printf(GetString(STR_READING_ROM_FILE));
        ROMSize = lseek(rom_fd, 0, SEEK_END);
        if (ROMSize != 64*1024 && ROMSize != 128*1024 && ROMSize != 256*1024 && ROMSize != 512*1024 && ROMSize != 1024*1024) {
                ErrorAlert(STR_ROM_SIZE_ERR);
                close(rom_fd);
                QuitEmulator();
        }
        lseek(rom_fd, 0, SEEK_SET);
        if (read(rom_fd, ROMBaseHost, ROMSize) != (ssize_t)ROMSize) {
                ErrorAlert(STR_ROM_FILE_READ_ERR);
                close(rom_fd);
                QuitEmulator();
        }


        // Initialize everything
        if (!InitAll())
                QuitEmulator();
        D(bug("Initialization complete\n"));


#ifdef ENABLE_MON
        // Setup SIGINT handler to enter mon
        sigemptyset(&sigint_sa.sa_mask);
        sigint_sa.sa_handler = (void (*)(int))sigint_handler;
        sigint_sa.sa_flags = 0;
        sigaction(SIGINT, &sigint_sa, NULL);
#endif


        return YES;
}

#undef QuitEmulator()


/*
 *  Quit emulator
 */

void QuitEmuNoExit()
{
        D(bug("QuitEmulator\n"));

        // Exit 680x0 emulation
        Exit680x0();

        // Deinitialize everything
        ExitAll();

        // Free ROM/RAM areas
        if (RAMBaseHost != VM_MAP_FAILED) {
                vm_release(RAMBaseHost, RAMSize + 0x100000);
                RAMBaseHost = NULL;
                ROMBaseHost = NULL;
        }

#if USE_SCRATCHMEM_SUBTERFUGE
        // Delete scratch memory area
        if (ScratchMem != (uint8 *)VM_MAP_FAILED) {
                vm_release((void *)(ScratchMem - SCRATCH_MEM_SIZE/2), SCRATCH_MEM_SIZE);
                ScratchMem = NULL;
        }
#endif

#if REAL_ADDRESSING
        // Delete Low Memory area
        if (lm_area_mapped)
                vm_release(0, 0x2000);
#endif
        
        // Exit VM wrappers
        vm_exit();

        // Exit system routines
        SysExit();

        // Exit preferences
        PrefsExit();
}

void QuitEmulator(void)
{
        QuitEmuNoExit();

        // Stop run loop?
        [NSApp terminate: nil];

        exit(0);
}


/*
 *  Code was patched, flush caches if neccessary (i.e. when using a real 680x0
 *  or a dynamically recompiling emulator)
 */

void FlushCodeCache(void *start, uint32 size)
{
#if USE_JIT
        if (UseJIT)
                flush_icache_range((uint8 *)start, size);
#endif
}


/*
 *  SIGINT handler, enters mon
 */

#ifdef ENABLE_MON
static void sigint_handler(...)
{
        uaecptr nextpc;
        extern void m68k_dumpstate(uaecptr *nextpc);
        m68k_dumpstate(&nextpc);
        VideoQuitFullScreen();
        char *arg[4] = {"mon", "-m", "-r", NULL};
        mon(3, arg);
        QuitEmulator();
}
#endif


#ifdef HAVE_PTHREADS
/*
 *  Pthread configuration
 */

void Set_pthread_attr(pthread_attr_t *attr, int priority)
{
        pthread_attr_init(attr);
#if defined(_POSIX_THREAD_PRIORITY_SCHEDULING)
        // Some of these only work for superuser
        if (geteuid() == 0) {
                pthread_attr_setinheritsched(attr, PTHREAD_EXPLICIT_SCHED);
                pthread_attr_setschedpolicy(attr, SCHED_FIFO);
                struct sched_param fifo_param;
                fifo_param.sched_priority = ((sched_get_priority_min(SCHED_FIFO)
                                                                         + sched_get_priority_max(SCHED_FIFO))
                                                                         / 2 + priority);
                pthread_attr_setschedparam(attr, &fifo_param);
        }
        if (pthread_attr_setscope(attr, PTHREAD_SCOPE_SYSTEM) != 0) {
#ifdef PTHREAD_SCOPE_BOUND_NP
            // If system scope is not available (eg. we're not running
            // with CAP_SCHED_MGT capability on an SGI box), try bound
            // scope.  It exposes pthread scheduling to the kernel,
            // without setting realtime priority.
            pthread_attr_setscope(attr, PTHREAD_SCOPE_BOUND_NP);
#endif
        }
#endif
}
#endif // HAVE_PTHREADS


/*
 *  Mutexes
 */

#ifdef HAVE_PTHREADS

struct B2_mutex {
        B2_mutex() {
                pthread_mutexattr_t attr;
                pthread_mutexattr_init(&attr);
                // Initialize the mutex for priority inheritance --
                // required for accurate timing.
#ifdef HAVE_PTHREAD_MUTEXATTR_SETPROTOCOL
                pthread_mutexattr_setprotocol(&attr, PTHREAD_PRIO_INHERIT);
#endif
#if defined(HAVE_PTHREAD_MUTEXATTR_SETTYPE) && defined(PTHREAD_MUTEX_NORMAL)
                pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_NORMAL);
#endif
#ifdef HAVE_PTHREAD_MUTEXATTR_SETPSHARED
                pthread_mutexattr_setpshared(&attr, PTHREAD_PROCESS_PRIVATE);
#endif
                pthread_mutex_init(&m, &attr);
                pthread_mutexattr_destroy(&attr);
        }
        ~B2_mutex() {
                pthread_mutex_trylock(&m);      // Make sure it's locked before
                pthread_mutex_unlock(&m);       // unlocking it.
                pthread_mutex_destroy(&m);
        }
        pthread_mutex_t m;
};

B2_mutex *B2_create_mutex(void)
{
        return new B2_mutex;
}

void B2_lock_mutex(B2_mutex *mutex)
{
        pthread_mutex_lock(&mutex->m);
}

void B2_unlock_mutex(B2_mutex *mutex)
{
        pthread_mutex_unlock(&mutex->m);
}

void B2_delete_mutex(B2_mutex *mutex)
{
        delete mutex;
}

#else

struct B2_mutex {
        int dummy;
};

B2_mutex *B2_create_mutex(void)
{
        return new B2_mutex;
}

void B2_lock_mutex(B2_mutex *mutex)
{
}

void B2_unlock_mutex(B2_mutex *mutex)
{
}

void B2_delete_mutex(B2_mutex *mutex)
{
        delete mutex;
}

#endif


/*
 *  Interrupt flags (must be handled atomically!)
 */

uint32 InterruptFlags = 0;

void SetInterruptFlag(uint32 flag)
{
        LOCK_INTFLAGS;
        InterruptFlags |= flag;
        UNLOCK_INTFLAGS;
}

void ClearInterruptFlag(uint32 flag)
{
        LOCK_INTFLAGS;
        InterruptFlags &= ~flag;
        UNLOCK_INTFLAGS;
}


/*
 *  Display error alert
 */

void ErrorAlert(const char *text)
{
        NSString *title  = [NSString stringWithCString:
                                                GetString(STR_ERROR_ALERT_TITLE) ];
        NSString *error  = [NSString stringWithCString: text];
        NSString *button = [NSString stringWithCString: GetString(STR_QUIT_BUTTON) ];

        NSLog(error);
        if ( PrefsFindBool("nogui") )
                return;
        VideoQuitFullScreen();
        NSRunCriticalAlertPanel(title, error, button, nil, nil);
}


/*
 *  Display warning alert
 */

void WarningAlert(const char *text)
{
        NSString *title   = [NSString stringWithCString:
                                                        GetString(STR_WARNING_ALERT_TITLE) ];
        NSString *warning = [NSString stringWithCString: text];
        NSString *button  = [NSString stringWithCString: GetString(STR_OK_BUTTON) ];

        NSLog(warning);
        if ( PrefsFindBool("nogui") )
                return;
        VideoQuitFullScreen();
        NSRunAlertPanel(title, warning, button, nil, nil);
}


/*
 *  Display choice alert
 */

bool ChoiceAlert(const char *text, const char *pos, const char *neg)
{
        NSString *title   = [NSString stringWithCString:
                                                        GetString(STR_WARNING_ALERT_TITLE) ];
        NSString *warning = [NSString stringWithCString: text];
        NSString *yes     = [NSString stringWithCString: pos];
        NSString *no      = [NSString stringWithCString: neg];

        return NSRunInformationalAlertPanel(title, warning, yes, no, nil);
}
Revision:	1.20
Committed:	2008-02-04T01:00:53Z (16 years, 4 months ago) by nigel
Branch:	MAIN
Changes since 1.19:	+32 -2 lines
Log Message:	Add a dummy Screen_fault_handler so this builds again, whitespace changes, set a working directory other than /, allow the file ROM to be opened from the bundle.
#	User	Rev	Content
1	nigel	1.1	/*
2	nigel	1.20	* $Id: main_macosx.mm,v 1.19 2008/01/01 09:40:32 gbeauche Exp $
3	nigel	1.1	*
4			* main_macosx.mm - Startup code for MacOS X
5			* Based (in a small way) on the default main.m,
6			and on Basilisk's main_unix.cpp
7			*
8	gbeauche	1.19	* Basilisk II (C) 1997-2008 Christian Bauer
9	nigel	1.1	*
10			* This program is free software; you can redistribute it and/or modify
11			* it under the terms of the GNU General Public License as published by
12			* the Free Software Foundation; either version 2 of the License, or
13			* (at your option) any later version.
14			*
15			* This program is distributed in the hope that it will be useful,
16			* but WITHOUT ANY WARRANTY; without even the implied warranty of
17			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			* GNU General Public License for more details.
19			*
20			* You should have received a copy of the GNU General Public License
21			* along with this program; if not, write to the Free Software
22			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23			*/
24	nigel	1.14
25			#import <AppKit/AppKit.h>
26			#undef check
27
28	nigel	1.10	#define PTHREADS // Why is this here?
29	nigel	1.1	#include "sysdeps.h"
30
31			#ifdef HAVE_PTHREADS
32			# include <pthread.h>
33			#endif
34
35			#if REAL_ADDRESSING \|\| DIRECT_ADDRESSING
36			# include <sys/mman.h>
37			#endif
38
39	nigel	1.8	#include <string>
40			using std::string;
41
42	nigel	1.1	#include "cpu_emulation.h"
43			#include "macos_util_macosx.h"
44			#include "main.h"
45			#include "prefs.h"
46			#include "prefs_editor.h"
47			#include "rom_patches.h"
48	nigel	1.8	#include "sigsegv.h"
49	nigel	1.1	#include "sys.h"
50			#include "user_strings.h"
51			#include "version.h"
52			#include "video.h"
53			#include "vm_alloc.h"
54			#include "xpram.h"
55
56	nigel	1.8	#if USE_JIT
57	gbeauche	1.16	extern void flush_icache_range(uint8 *start, uint32 size); // from compemu_support.cpp
58	nigel	1.8	#endif
59
60	nigel	1.1	#ifdef ENABLE_MON
61			# include "mon.h"
62			#endif
63
64			#define DEBUG 0
65			#include "debug.h"
66
67
68			#include "main_macosx.h" // To bridge between main() and misc. classes
69
70
71			// Constants
72			const char ROM_FILE_NAME[] = "ROM";
73			const int SCRATCH_MEM_SIZE = 0x10000; // Size of scratch memory area
74
75
76	nigel	1.20	static char *bundle = NULL; // If in an OS X application bundle, its path
77
78
79	nigel	1.1	// CPU and FPU type, addressing mode
80			int CPUType;
81			bool CPUIs68060;
82			int FPUType;
83			bool TwentyFourBitAddressing;
84
85
86			// Global variables
87
88			#ifdef HAVE_PTHREADS
89
90			static pthread_mutex_t intflag_lock = PTHREAD_MUTEX_INITIALIZER; // Mutex to protect InterruptFlags
91			#define LOCK_INTFLAGS pthread_mutex_lock(&intflag_lock)
92			#define UNLOCK_INTFLAGS pthread_mutex_unlock(&intflag_lock)
93
94			#else
95
96			#define LOCK_INTFLAGS
97			#define UNLOCK_INTFLAGS
98
99			#endif
100
101			#if USE_SCRATCHMEM_SUBTERFUGE
102			uint8 *ScratchMem = NULL; // Scratch memory for Mac ROM writes
103			#endif
104
105	nigel	1.3	#ifdef ENABLE_MON
106	nigel	1.1	static struct sigaction sigint_sa; // sigaction for SIGINT handler
107			static void sigint_handler(...);
108	nigel	1.3	#endif
109	nigel	1.1
110			#if REAL_ADDRESSING
111			static bool lm_area_mapped = false; // Flag: Low Memory area mmap()ped
112			#endif
113
114
115	nigel	1.8	/*
116	nigel	1.15	* Helpers to map memory that can be accessed from the Mac side
117	nigel	1.14	*/
118
119	gbeauche	1.17	// NOTE: VM_MAP_32BIT is only used when compiling a 64-bit JIT on specific platforms
120	nigel	1.14	void *vm_acquire_mac(size_t size)
121			{
122	gbeauche	1.17	return vm_acquire(size, VM_MAP_DEFAULT \| VM_MAP_32BIT);
123	nigel	1.14	}
124
125	nigel	1.15	static int vm_acquire_mac_fixed(void *addr, size_t size)
126			{
127	gbeauche	1.17	return vm_acquire_fixed(addr, size, VM_MAP_DEFAULT \| VM_MAP_32BIT);
128	nigel	1.15	}
129
130	nigel	1.14
131			/*
132	nigel	1.10	* SIGSEGV handler
133			*/
134
135	gbeauche	1.18	static sigsegv_return_t sigsegv_handler(sigsegv_info_t *sip)
136	nigel	1.10	{
137	gbeauche	1.18	const uintptr fault_address = (uintptr)sigsegv_get_fault_address(sip);
138	nigel	1.10	#if ENABLE_VOSF
139			// Handle screen fault
140	gbeauche	1.18	extern bool Screen_fault_handler(sigsegv_info_t *sip);
141			if (Screen_fault_handler(sip))
142	nigel	1.10	return SIGSEGV_RETURN_SUCCESS;
143			#endif
144
145			#ifdef HAVE_SIGSEGV_SKIP_INSTRUCTION
146			// Ignore writes to ROM
147			if (((uintptr)fault_address - (uintptr)ROMBaseHost) < ROMSize)
148			return SIGSEGV_RETURN_SKIP_INSTRUCTION;
149
150			// Ignore all other faults, if requested
151			if (PrefsFindBool("ignoresegv"))
152			return SIGSEGV_RETURN_SKIP_INSTRUCTION;
153			#endif
154
155			return SIGSEGV_RETURN_FAILURE;
156			}
157
158
159			/*
160	nigel	1.8	* Dump state when everything went wrong after a SEGV
161			*/
162
163	gbeauche	1.18	static void sigsegv_dump_state(sigsegv_info_t *sip)
164	nigel	1.8	{
165	gbeauche	1.18	const sigsegv_address_t fault_address = sigsegv_get_fault_address(sip);
166			const sigsegv_address_t fault_instruction = sigsegv_get_fault_instruction_address(sip);
167	nigel	1.8	fprintf(stderr, "Caught SIGSEGV at address %p", fault_address);
168	gbeauche	1.18	if (fault_instruction != SIGSEGV_INVALID_ADDRESS)
169	nigel	1.8	fprintf(stderr, " [IP=%p]", fault_instruction);
170			fprintf(stderr, "\n");
171			uaecptr nextpc;
172			extern void m68k_dumpstate(uaecptr *nextpc);
173			m68k_dumpstate(&nextpc);
174			#if USE_JIT && JIT_DEBUG
175			extern void compiler_dumpstate(void);
176			compiler_dumpstate();
177			#endif
178			VideoQuitFullScreen();
179			#ifdef ENABLE_MON
180			char *arg[4] = {"mon", "-m", "-r", NULL};
181			mon(3, arg);
182	nigel	1.15	#endif
183	nigel	1.8	QuitEmulator();
184			}
185
186	nigel	1.1
187			/*
188	nigel	1.20	* Screen fault handler
189			*/
190
191			bool Screen_fault_handler(sigsegv_info_t *sip)
192			{
193			return true;
194			}
195
196
197			/*
198	nigel	1.1	* Main program
199			*/
200
201			static void usage(const char *prg_name)
202			{
203			printf("Usage: %s [OPTION...]\n", prg_name);
204			printf("\nUnix options:\n");
205			printf(" --help\n display this usage message\n");
206	nigel	1.8	printf(" --config FILE\n read/write configuration from/to FILE\n");
207	nigel	1.1	printf(" --break ADDRESS\n set ROM breakpoint\n");
208			printf(" --rominfo\n dump ROM information\n");
209	nigel	1.8	LoadPrefs(); // read the prefs file so PrefsPrintUsage() will print the correct default values
210	nigel	1.1	PrefsPrintUsage();
211			exit(0);
212			}
213
214			int main(int argc, char **argv)
215			{
216			// Initialize variables
217			RAMBaseHost = NULL;
218			ROMBaseHost = NULL;
219			srand(time(NULL));
220			tzset();
221
222			// Print some info
223			printf(GetString(STR_ABOUT_TEXT1), VERSION_MAJOR, VERSION_MINOR);
224			printf(" %s\n", GetString(STR_ABOUT_TEXT2));
225
226			// Parse command line arguments
227			for (int i=1; i<argc; i++) {
228			if (strcmp(argv[i], "--help") == 0) {
229			usage(argv[0]);
230			} else if (strncmp(argv[i], "-psn_", 5) == 0) {// OS X process identifier
231			i++;
232			} else if (strcmp(argv[i], "--break") == 0) {
233			i++;
234			if (i < argc)
235			ROMBreakpoint = strtol(argv[i], NULL, 0);
236	nigel	1.8	} else if (strcmp(argv[i], "--config") == 0) {
237			argv[i++] = NULL;
238			if (i < argc) {
239			extern string UserPrefsPath; // from prefs_unix.cpp
240			UserPrefsPath = argv[i];
241			argv[i] = NULL;
242			}
243	nigel	1.1	} else if (strcmp(argv[i], "--rominfo") == 0) {
244			PrintROMInfo = true;
245			} else if (argv[i][0] == '-') {
246			fprintf(stderr, "Unrecognized option '%s'\n", argv[i]);
247			usage(argv[0]);
248			}
249			}
250
251	nigel	1.10	// Read preferences
252			PrefsInit(argc, argv);
253
254	nigel	1.1	// Init system routines
255			SysInit();
256
257	nigel	1.20	// Set the current directory somewhere useful.
258			// Handy for storing the ROM file
259			bundle = strstr(argv[0], "BasiliskII.app/Contents/MacOS/BasiliskII");
260			if (bundle)
261			{
262			while (*bundle != '/')
263			++bundle;
264
265			*bundle = 0; // Throw away Contents/... on end of argv[0]
266			bundle = argv[0];
267
268			chdir(bundle);
269			}
270
271	nigel	1.1	// Open display, attach to window server,
272			// load pre-instantiated classes from MainMenu.nib, start run loop
273			int i = NSApplicationMain(argc, (const char **)argv);
274			// We currently never get past here, because QuitEmulator() does an exit()
275
276			// Exit system routines
277			SysExit();
278
279			// Exit preferences
280			PrefsExit();
281
282			return i;
283			}
284
285	nigel	1.7	#define QuitEmulator() { QuitEmuNoExit() ; return NO; }
286	nigel	1.1
287			bool InitEmulator (void)
288			{
289			char str[256];
290
291
292	nigel	1.10	// Install the handler for SIGSEGV
293			if (!sigsegv_install_handler(sigsegv_handler)) {
294			sprintf(str, GetString(STR_SIG_INSTALL_ERR), "SIGSEGV", strerror(errno));
295			ErrorAlert(str);
296			QuitEmulator();
297			}
298	nigel	1.8
299			// Register dump state function when we got mad after a segfault
300			sigsegv_set_dump_state(sigsegv_dump_state);
301
302	nigel	1.1	// Read RAM size
303			RAMSize = PrefsFindInt32("ramsize") & 0xfff00000; // Round down to 1MB boundary
304			if (RAMSize < 1024*1024) {
305			WarningAlert(GetString(STR_SMALL_RAM_WARN));
306			RAMSize = 1024*1024;
307			}
308	nigel	1.15	if (RAMSize > 102310241024) // Cap to 1023MB (APD crashes at 1GB)
309			RAMSize = 102310241024;
310	nigel	1.1
311			#if REAL_ADDRESSING \|\| DIRECT_ADDRESSING
312			RAMSize = RAMSize & -getpagesize(); // Round down to page boundary
313			#endif
314
315			// Initialize VM system
316			vm_init();
317
318			#if REAL_ADDRESSING
319			// Flag: RAM and ROM are contigously allocated from address 0
320			bool memory_mapped_from_zero = false;
321	nigel	1.15
322			// Make sure to map RAM & ROM at address 0 only on platforms that
323			// supports linker scripts to relocate the Basilisk II executable
324			// above 0x70000000
325			#if HAVE_LINKER_SCRIPT
326			const bool can_map_all_memory = true;
327			#else
328	nigel	1.1	const bool can_map_all_memory = false;
329			#endif
330
331			// Try to allocate all memory from 0x0000, if it is not known to crash
332	nigel	1.15	if (can_map_all_memory && (vm_acquire_mac_fixed(0, RAMSize + 0x100000) == 0)) {
333	nigel	1.1	D(bug("Could allocate RAM and ROM from 0x0000\n"));
334			memory_mapped_from_zero = true;
335			}
336	nigel	1.15
337	nigel	1.10	#ifndef PAGEZERO_HACK
338	nigel	1.1	// Otherwise, just create the Low Memory area (0x0000..0x2000)
339	nigel	1.15	else if (vm_acquire_mac_fixed(0, 0x2000) == 0) {
340	nigel	1.1	D(bug("Could allocate the Low Memory globals\n"));
341			lm_area_mapped = true;
342			}
343
344			// Exit on failure
345			else {
346			sprintf(str, GetString(STR_LOW_MEM_MMAP_ERR), strerror(errno));
347			ErrorAlert(str);
348			QuitEmulator();
349			}
350	nigel	1.10	#endif
351	nigel	1.4	#else
352			*str = 0; // Eliminate unused variable warning
353	nigel	1.10	#endif /* REAL_ADDRESSING */
354	nigel	1.1
355			// Create areas for Mac RAM and ROM
356			#if REAL_ADDRESSING
357			if (memory_mapped_from_zero) {
358			RAMBaseHost = (uint8 *)0;
359			ROMBaseHost = RAMBaseHost + RAMSize;
360			}
361			else
362			#endif
363			{
364	nigel	1.14	uint8 ram_rom_area = (uint8 )vm_acquire_mac(RAMSize + 0x100000);
365			if (ram_rom_area == VM_MAP_FAILED) {
366	nigel	1.1	ErrorAlert(STR_NO_MEM_ERR);
367			QuitEmulator();
368			}
369	nigel	1.14	RAMBaseHost = ram_rom_area;
370			ROMBaseHost = RAMBaseHost + RAMSize;
371	nigel	1.1	}
372
373			#if USE_SCRATCHMEM_SUBTERFUGE
374			// Allocate scratch memory
375	nigel	1.15	ScratchMem = (uint8 *)vm_acquire_mac(SCRATCH_MEM_SIZE);
376	nigel	1.1	if (ScratchMem == VM_MAP_FAILED) {
377			ErrorAlert(STR_NO_MEM_ERR);
378			QuitEmulator();
379			}
380			ScratchMem += SCRATCH_MEM_SIZE/2; // ScratchMem points to middle of block
381			#endif
382
383			#if DIRECT_ADDRESSING
384			// RAMBaseMac shall always be zero
385			MEMBaseDiff = (uintptr)RAMBaseHost;
386			RAMBaseMac = 0;
387			ROMBaseMac = Host2MacAddr(ROMBaseHost);
388			#endif
389			#if REAL_ADDRESSING
390	nigel	1.15	RAMBaseMac = Host2MacAddr(RAMBaseHost);
391			ROMBaseMac = Host2MacAddr(ROMBaseHost);
392	nigel	1.1	#endif
393			D(bug("Mac RAM starts at %p (%08x)\n", RAMBaseHost, RAMBaseMac));
394			D(bug("Mac ROM starts at %p (%08x)\n", ROMBaseHost, ROMBaseMac));
395
396			// Get rom file path from preferences
397			const char *rom_path = PrefsFindString("rom");
398	nigel	1.6	if ( ! rom_path )
399	nigel	1.20	if ( bundle )
400			WarningAlert("No rom pathname set. Trying BasiliskII.app/ROM");
401			else
402	nigel	1.6	WarningAlert("No rom pathname set. Trying ./ROM");
403	nigel	1.1
404			// Load Mac ROM
405			int rom_fd = open(rom_path ? rom_path : ROM_FILE_NAME, O_RDONLY);
406			if (rom_fd < 0) {
407			ErrorAlert(STR_NO_ROM_FILE_ERR);
408			QuitEmulator();
409			}
410			printf(GetString(STR_READING_ROM_FILE));
411			ROMSize = lseek(rom_fd, 0, SEEK_END);
412			if (ROMSize != 641024 && ROMSize != 1281024 && ROMSize != 2561024 && ROMSize != 5121024 && ROMSize != 1024*1024) {
413			ErrorAlert(STR_ROM_SIZE_ERR);
414			close(rom_fd);
415			QuitEmulator();
416			}
417			lseek(rom_fd, 0, SEEK_SET);
418			if (read(rom_fd, ROMBaseHost, ROMSize) != (ssize_t)ROMSize) {
419			ErrorAlert(STR_ROM_FILE_READ_ERR);
420			close(rom_fd);
421			QuitEmulator();
422			}
423
424
425			// Initialize everything
426			if (!InitAll())
427			QuitEmulator();
428			D(bug("Initialization complete\n"));
429
430
431			#ifdef ENABLE_MON
432			// Setup SIGINT handler to enter mon
433			sigemptyset(&sigint_sa.sa_mask);
434			sigint_sa.sa_handler = (void (*)(int))sigint_handler;
435			sigint_sa.sa_flags = 0;
436			sigaction(SIGINT, &sigint_sa, NULL);
437			#endif
438
439
440			return YES;
441			}
442
443			#undef QuitEmulator()
444
445
446			/*
447			* Quit emulator
448			*/
449
450			void QuitEmuNoExit()
451			{
452			D(bug("QuitEmulator\n"));
453
454			// Exit 680x0 emulation
455			Exit680x0();
456
457			// Deinitialize everything
458			ExitAll();
459
460			// Free ROM/RAM areas
461			if (RAMBaseHost != VM_MAP_FAILED) {
462	nigel	1.14	vm_release(RAMBaseHost, RAMSize + 0x100000);
463	nigel	1.1	RAMBaseHost = NULL;
464	nigel	1.15	ROMBaseHost = NULL;
465	nigel	1.1	}
466
467			#if USE_SCRATCHMEM_SUBTERFUGE
468			// Delete scratch memory area
469			if (ScratchMem != (uint8 *)VM_MAP_FAILED) {
470			vm_release((void *)(ScratchMem - SCRATCH_MEM_SIZE/2), SCRATCH_MEM_SIZE);
471			ScratchMem = NULL;
472			}
473			#endif
474
475			#if REAL_ADDRESSING
476			// Delete Low Memory area
477			if (lm_area_mapped)
478			vm_release(0, 0x2000);
479			#endif
480
481			// Exit VM wrappers
482			vm_exit();
483
484			// Exit system routines
485			SysExit();
486
487			// Exit preferences
488			PrefsExit();
489			}
490
491			void QuitEmulator(void)
492			{
493			QuitEmuNoExit();
494	nigel	1.6
495			// Stop run loop?
496			[NSApp terminate: nil];
497
498	nigel	1.1	exit(0);
499			}
500
501
502			/*
503			* Code was patched, flush caches if neccessary (i.e. when using a real 680x0
504			* or a dynamically recompiling emulator)
505			*/
506
507			void FlushCodeCache(void *start, uint32 size)
508			{
509	nigel	1.8	#if USE_JIT
510	nigel	1.20	if (UseJIT)
511	gbeauche	1.16	flush_icache_range((uint8 *)start, size);
512	nigel	1.8	#endif
513	nigel	1.1	}
514
515
516			/*
517			* SIGINT handler, enters mon
518			*/
519
520			#ifdef ENABLE_MON
521			static void sigint_handler(...)
522			{
523			uaecptr nextpc;
524			extern void m68k_dumpstate(uaecptr *nextpc);
525			m68k_dumpstate(&nextpc);
526			VideoQuitFullScreen();
527			char *arg[4] = {"mon", "-m", "-r", NULL};
528			mon(3, arg);
529			QuitEmulator();
530			}
531			#endif
532
533
534	nigel	1.14	#ifdef HAVE_PTHREADS
535			/*
536			* Pthread configuration
537			*/
538
539			void Set_pthread_attr(pthread_attr_t *attr, int priority)
540			{
541			pthread_attr_init(attr);
542			#if defined(_POSIX_THREAD_PRIORITY_SCHEDULING)
543			// Some of these only work for superuser
544			if (geteuid() == 0) {
545			pthread_attr_setinheritsched(attr, PTHREAD_EXPLICIT_SCHED);
546			pthread_attr_setschedpolicy(attr, SCHED_FIFO);
547			struct sched_param fifo_param;
548			fifo_param.sched_priority = ((sched_get_priority_min(SCHED_FIFO)
549			+ sched_get_priority_max(SCHED_FIFO))
550			/ 2 + priority);
551			pthread_attr_setschedparam(attr, &fifo_param);
552			}
553			if (pthread_attr_setscope(attr, PTHREAD_SCOPE_SYSTEM) != 0) {
554			#ifdef PTHREAD_SCOPE_BOUND_NP
555			// If system scope is not available (eg. we're not running
556			// with CAP_SCHED_MGT capability on an SGI box), try bound
557			// scope. It exposes pthread scheduling to the kernel,
558			// without setting realtime priority.
559			pthread_attr_setscope(attr, PTHREAD_SCOPE_BOUND_NP);
560			#endif
561			}
562			#endif
563			}
564			#endif // HAVE_PTHREADS
565
566
567	nigel	1.1	/*
568			* Mutexes
569			*/
570
571			#ifdef HAVE_PTHREADS
572
573			struct B2_mutex {
574	nigel	1.10	B2_mutex() {
575			pthread_mutexattr_t attr;
576			pthread_mutexattr_init(&attr);
577			// Initialize the mutex for priority inheritance --
578			// required for accurate timing.
579			#ifdef HAVE_PTHREAD_MUTEXATTR_SETPROTOCOL
580			pthread_mutexattr_setprotocol(&attr, PTHREAD_PRIO_INHERIT);
581			#endif
582			#if defined(HAVE_PTHREAD_MUTEXATTR_SETTYPE) && defined(PTHREAD_MUTEX_NORMAL)
583			pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_NORMAL);
584			#endif
585			#ifdef HAVE_PTHREAD_MUTEXATTR_SETPSHARED
586			pthread_mutexattr_setpshared(&attr, PTHREAD_PROCESS_PRIVATE);
587			#endif
588			pthread_mutex_init(&m, &attr);
589			pthread_mutexattr_destroy(&attr);
590			}
591			~B2_mutex() {
592			pthread_mutex_trylock(&m); // Make sure it's locked before
593			pthread_mutex_unlock(&m); // unlocking it.
594			pthread_mutex_destroy(&m);
595			}
596	nigel	1.1	pthread_mutex_t m;
597			};
598
599			B2_mutex *B2_create_mutex(void)
600			{
601			return new B2_mutex;
602			}
603
604			void B2_lock_mutex(B2_mutex *mutex)
605			{
606			pthread_mutex_lock(&mutex->m);
607			}
608
609			void B2_unlock_mutex(B2_mutex *mutex)
610			{
611			pthread_mutex_unlock(&mutex->m);
612			}
613
614			void B2_delete_mutex(B2_mutex *mutex)
615			{
616			delete mutex;
617			}
618
619			#else
620
621			struct B2_mutex {
622			int dummy;
623			};
624
625			B2_mutex *B2_create_mutex(void)
626			{
627			return new B2_mutex;
628			}
629
630			void B2_lock_mutex(B2_mutex *mutex)
631			{
632			}
633
634			void B2_unlock_mutex(B2_mutex *mutex)
635			{
636			}
637
638			void B2_delete_mutex(B2_mutex *mutex)
639			{
640			delete mutex;
641			}
642
643			#endif
644
645
646			/*
647			* Interrupt flags (must be handled atomically!)
648			*/
649
650			uint32 InterruptFlags = 0;
651
652			void SetInterruptFlag(uint32 flag)
653			{
654			LOCK_INTFLAGS;
655			InterruptFlags \|= flag;
656			UNLOCK_INTFLAGS;
657			}
658
659			void ClearInterruptFlag(uint32 flag)
660			{
661			LOCK_INTFLAGS;
662			InterruptFlags &= ~flag;
663			UNLOCK_INTFLAGS;
664			}
665
666
667			/*
668			* Display error alert
669			*/
670
671			void ErrorAlert(const char *text)
672			{
673			NSString *title = [NSString stringWithCString:
674			GetString(STR_ERROR_ALERT_TITLE) ];
675			NSString *error = [NSString stringWithCString: text];
676			NSString *button = [NSString stringWithCString: GetString(STR_QUIT_BUTTON) ];
677
678			NSLog(error);
679	nigel	1.10	if ( PrefsFindBool("nogui") )
680			return;
681			VideoQuitFullScreen();
682	nigel	1.1	NSRunCriticalAlertPanel(title, error, button, nil, nil);
683			}
684
685
686			/*
687			* Display warning alert
688			*/
689
690			void WarningAlert(const char *text)
691			{
692			NSString *title = [NSString stringWithCString:
693			GetString(STR_WARNING_ALERT_TITLE) ];
694			NSString *warning = [NSString stringWithCString: text];
695			NSString *button = [NSString stringWithCString: GetString(STR_OK_BUTTON) ];
696
697			NSLog(warning);
698	nigel	1.10	if ( PrefsFindBool("nogui") )
699			return;
700			VideoQuitFullScreen();
701	nigel	1.1	NSRunAlertPanel(title, warning, button, nil, nil);
702			}
703
704
705			/*
706			* Display choice alert
707			*/
708
709			bool ChoiceAlert(const char text, const char pos, const char *neg)
710			{
711			NSString *title = [NSString stringWithCString:
712			GetString(STR_WARNING_ALERT_TITLE) ];
713			NSString *warning = [NSString stringWithCString: text];
714			NSString *yes = [NSString stringWithCString: pos];
715			NSString *no = [NSString stringWithCString: neg];
716
717			return NSRunInformationalAlertPanel(title, warning, yes, no, nil);
718			}