AlphaSim.cpp

/* ES40 emulator.
 * Copyright (C) 2007-2008 by the ES40 Emulator Project
 *
 * WWW    : http://sourceforge.net/projects/es40
 * E-mail : camiel@camicom.com
 * 
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Although this is not required, the author would appreciate being notified of, 
 * and receiving any modifications you may make to the source code that might serve
 * the general public.
 */

/** 
 * \file
 * Defines the entry point for the application.
 *
 * $Id: AlphaSim.cpp,v 1.42 2008/03/04 19:33:47 iamcamiel Exp $
 *
 * X-1.42       Camiel Vanderhoeven                             04-MAR-2008
 *      Version updated to 0.18.
 *
 * X-1.41       Brian Wheeler                                   26-FEB-2008
 *   a) Catch SIGUSR1 to trigger the backtracer if es40 seems to have hung.
 *   b) Use _exit() to really really quit when a SIGSEGV is caught.
 *
 * X-1.40       Brian Wheeler                                   07-FEB-2008
 *      On GNU systems, display a backtrace when a segmentation fault
 *      occurs, and DEBUG_BACKTRACE has been defined.
 *
 * X-1.39       Brian Wheeler                                   05-FEB-2008
 *      Display a message when system initialization has failed.
 *
 * X-1.38       Camiel Vanderhoeven                             26-JAN-2008
 *      Lifted hardcoded file-size limit of 10,000 bytes for config file.
 *
 * X-1.37       Camiel Vanderhoeven                             02-JAN-2008
 *      Version updated to 0.17.
 *
 * X-1.35       Camiel Vanderhoeven                             28-DEC-2007
 *      Throw exceptions rather than just exiting when errors occur.
 *
 * X-1.34       Camiel Vanderhoeven                             28-DEC-2007
 *      Keep the compiler happy.
 *
 * X-1.33       Camiel Vanderhoeven                             10-DEC-2007
 *      Use configurator to read config-file and set up devices.
 *
 * X-1.32       Camiel Vanderhoeven                             7-DEC-2007
 *      Moved SDL_Init to gui implementation.
 *
 * X-1.31       Camiel Vanderhoeven/Brian Wheeler               6-DEC-2007
 *      Use Boch's SDL gui plugin (with thanks to the Bochs project!!)
 *
 * X-1.30       Camiel Vanderhoeven                             2-DEC-2007
 *      Added support for code profiling.
 *
 * X-1.29       Brian Wheeler                                   1-DEC-2007
 *      Added console support if USE_CONSOLE is defined.
 *
 * X-1.28       Brian Wheeler                                   22-NOV-2007
 *      Added nic0.disabled configuration option.
 *
 * X-1.27       Camiel Vanderhoeven                             17-NOV-2007
 *      Use FAILURE.
 *
 * X-1.26       Camiel Vanderhoeven                             17-NOV-2007
 *      Version updated to 0.16. Made it possible to disable the network
 *      by defining NO_NETWORK.
 *
 * X-1.25       Camiel Vanderhoeven                             14-NOV-2007
 *      Added network.
 *
 * X-1.24       Camiel Vanderhoeven                             08-NOV-2007
 *      Version updated to 0.15.
 *
 * X-1.23       Camiel Vanderhoeven                             02-NOV-2007
 *      Version updated to 0.14.
 *
 * X-1.22       Camiel Vanderhoeven                             10-APR-2007
 *      Replaced LoadROM(...) and SelectROM() calls with a single LoadROM()
 *      call. (See System.cpp, X-1.23).
 *
 * X-1.21       Camiel Vanderhoeven                             10-APR-2007
 *      Calls to LoadROM and SelectROM changed to fit X-1.22 of System.cpp.
 *
 * X-1.20       Camiel Vanderhoeven                             31-MAR-2007
 *      Added old changelog comments.
 *
 * X-1.19	Camiel Vanderhoeven				28-FEB-2007
 *	Call lockstep_init() if needed.
 *
 * X-1.18	Camiel Vanderhoeven				16-FEB-2007
 *	No longer load CSV files, this can be done with the LOAD CSV command
 *	in the Interactive De-Bugger.
 *
 * X-1.17	Camiel Vanderhoeven				16-FEB-2007
 *   a)	Removed most of the code from this file. The main function no longer
 *	controls every clocktick, but rather transfers control directly to
 *	CSystem::Run(), or to the Interactive Debugger.
 *   b)	In the IDB-version, the name of a script to execute can be specified
 *	on the command line (es40_idb @script).
 *
 * X-1.16	Camiel Vanderhoeven				13-FEB-2007
 *	The define DISASM_START can be set to the number of processor cycles
 *	after which the disassembly will start.
 *
 * X-1.15	Camiel Vanderhoeven				13-FEB-2007
 *	The define DO_SETPC can be set to the address of the first 
 *	instruction to be executed.
 *
 * X-1.14	Camiel Vanderhoeven				12-FEB-2007
 *	Use methods provided by CCPU rather than directly accessing its 
 *	member variables.
 *
 * X-1.13	Camiel Vanderhoeven				12-FEB-2007
 *	Added comments.
 *
 * X-1.12	Camiel Vanderhoeven				9-FEB-2007
 *	Removed an obscure hack.
 *
 * X-1.11       Camiel Vanderhoeven                             9-FEB-2007
 *      If DO_DISASM is set, disassembly will be output.
 *
 * X-1.10	Brian Wheeler					7-FEB-2007
 *	Configuration file may be specified on the command line.
 *
 * X-1.9	Camiel Vanderhoeven				7-FEB-2007
 *	Add instantiation of trace engine.
 *
 * X-1.8	Camiel Vanderhoeven				3-FEB-2007
 *	RUN_LT can be set to provide a breakpoint (end if pc < defined value)
 *
 * X-1.7        Brian Wheeler                                   3-FEB-2007
 *      Formatting.
 *
 * X-1.6	Brian Wheeler					3-FEB-2007
 *	Support for execution speed timing on Linux
 *
 * X-1.5	Brian Wheeler					3-FEB-2007
 *	Support for configuration file.
 *
 * X-1.4	Brian Wheeler					3-FEB-2007
 *	Made execution speed timing dependent on _WIN32 (since this code
 *	uses a lot of Windows-specific features, and won't compile on
 *	Linux.
 *
 * X-1.3        Brian Wheeler                                   3-FEB-2007
 *      Scanf calls made compatible with Linux/GCC/glibc.
 *      
 * X-1.2        Brian Wheeler                                   3-FEB-2007
 *      Includes are now case-correct (necessary on Linux)
 *
 * X-1.1        Camiel Vanderhoeven                             19-JAN-2007
 *      Initial version in CVS.
 *
 * \author Camiel Vanderhoeven (camiel@camicom.com / http://www.camicom.com)
 **/

#include "StdAfx.h"
#include "System.h"
#include "Flash.h"
#include "DPR.h"

#include "lockstep.h"

/// "standard" locations for a configuration file.  This will be port specific.
char *path[]={
#if defined(_WIN32)
  ".\\es40.cfg",
  "c:\\es40.cfg",
  "c:\\windows\\es40.cfg",
#else
  "./es40.cfg",
  "/etc/es40.cfg",
  "/usr/etc/es40.cfg",
  "/usr/local/etc/es40.cfg",
#endif
  0
};

#ifdef DEBUG_BACKTRACE
#ifdef __GNUG__
#include <execinfo.h>
#include <signal.h>
#define HAS_BACKTRACE

#define BTCOUNT 100
void *btbuffer[BTCOUNT];

void segv_handler(int signum) {
  int nptrs = backtrace(btbuffer, BTCOUNT);
  char **strings;

  printf("%%SYS-F-SEGFAULT: The Alpha Simulator has Segfaulted.\n");
  printf("-SYS-F-SEGFAULT: Backtrace follows.\n");

  printf("backtrace() returned %d addresses.\n",nptrs);
  strings = backtrace_symbols(btbuffer,nptrs);
  if(strings==NULL) {
    perror("backtrace_symbols");
    exit(1);
  }

  for(int i = 0; i < nptrs; i++) {
    printf("%3d %s\n",nptrs-i, strings[i]);
  }
  free(strings);
  if(signum==SIGSEGV) _exit(1);
}

#else
#warning "Your compiler isn't configured to support backtraces."
#endif // __GNUG__
#endif

/**
 * Entry point for the application.
 *
 * Does the following:
 *  - Try to find the configuration file.
 *  - Reads the configuration file, and uses the configurator to instantiate all system components.
 *  - Creates the trace-engine if in debug mode.
 *  - Runs the emulator.
 *  - Cleans up.
 *  .
 **/

int main(int argc, char* argv[])
{

  printf("\n\n");
  printf("   **======================================================================**\n");
  printf("   ||                             ES40  emulator                           ||\n");
  printf("   ||                              Version 0.18                            ||\n");
  printf("   ||                                                                      ||\n");
  printf("   ||  Copyright (C) 2007-2008 by the ES40 Emulator Project                ||\n");
  printf("   ||  Website: http://sourceforge.net/projects/es40                       ||\n");
  printf("   ||  E-mail : camiel@camicom.com                                         ||\n");
  printf("   ||                                                                      ||\n");
  printf("   ||  This program is free software; you can redistribute it and/or       ||\n");
  printf("   ||  modify it under the terms of the GNU General Public License         ||\n");
  printf("   ||  as published by the Free Software Foundation; either version 2      ||\n");
  printf("   ||  of the License, or (at your option) any later version.              ||\n");
  printf("   **======================================================================**\n");
  printf("\n\n");

  char *filename = 0;
  FILE *f;

#ifdef HAS_BACKTRACE
  signal(SIGSEGV, &segv_handler);
  signal(SIGUSR1, &segv_handler);
#endif

  try 
  {
#if defined(IDB) && (defined(LS_MASTER) || defined(LS_SLAVE))
	lockstep_init();
#endif
#if defined(IDB)
	if ((argc == 2 || argc==3) && argv[1][0] != '@')
#else
	if (argc == 2)
#endif
	{
	  filename = argv[1];
    } 
    else 
    {
      for(int i = 0 ; path[i] ; i++) 
      {
        filename=path[i];
        f=fopen(path[i],"r");
        if(f != NULL) 
        {
		  fclose(f);
		  filename = path[i];
		  break;
        }
      }
      if(filename==NULL)
        FAILURE("Configuration file not found.");
    }

    char * ch1;
    size_t ll1;
    f = fopen(filename,"rb");
    fseek(f,0,SEEK_END);
    ll1 = ftell(f);
    ch1 = (char *) calloc(ll1,1);
    fseek(f,0,SEEK_SET);
    ll1 = fread(ch1,1,ll1,f);
    CConfigurator * c = new CConfigurator(0,0,0,ch1,ll1);
    fclose(f);
    free(ch1);

    if(!theSystem) 
    {
      printf("%%SYS-F-INIT: Initialization of system has failed. Syntax error in config?.\n");
      exit(1);
    }

#if defined(IDB)
    trc = new CTraceEngine(theSystem);
#endif

    theSystem->LoadROM();

    theSROM->RestoreStateF();
    theDPR->RestoreStateF();

#if defined(PROFILE)
    {
      u64 p_i;
      for (p_i = PROFILE_FROM; p_i < PROFILE_TO; p_i+=(4*PROFILE_BUCKSIZE))
        PROFILE_BUCKET(p_i) = 0;
      profiled_insts = 0;
    }
#endif


#if defined(IDB)
    if (argc>1 && argc<4 && argv[argc-1][0]=='@')
      trc->run_script(argv[argc-1] + 1);
    else
      trc->run_script(NULL);
#else

    if (theSystem->Run()>0)
    {
      // save flash and dpr rom only if not terminated with a fatal error
      theSROM->SaveStateF();
      theDPR->SaveStateF();
    }
#endif

#if defined(PROFILE)
    {
      FILE * p_fp;
      u64 p_max = 0;
      u64 p_i;
      int p_j;

      printf("Writing profile to profile.txt");

      p_fp = fopen("profile.txt","w");
      for (p_i = PROFILE_FROM; p_i < PROFILE_TO; p_i+=(4*PROFILE_BUCKSIZE))
      {
        if (PROFILE_BUCKET(p_i)>p_max)
          p_max = PROFILE_BUCKET(p_i);
      }
      fprintf(p_fp,"p_max = %10" LL "d; %10" LL "d profiled instructions.\n\n",p_max,profiled_insts);
      for (p_i = PROFILE_FROM; p_i < PROFILE_TO; p_i+=(4*PROFILE_BUCKSIZE))
      {
        if (PROFILE_BUCKET(p_i))
        {
          fprintf(p_fp,"%016" LL "x: %10" LL "d ",p_i,PROFILE_BUCKET(p_i));
          for(p_j=0;p_j<(((float)PROFILE_BUCKET(p_i)/(float)p_max)*100);p_j++)
            fprintf(p_fp,"*");
          fprintf(p_fp,"\n");
        }
      }
      fclose(p_fp);
    }
#endif

    delete theSystem;
  }
  catch(int)
  {
	if (theSystem)
	  delete theSystem;
  }
  return 0;
}