/* * main.c - VICE main startup entry. * * Written by * Ettore Perazzoli * Teemu Rantanen * Vesa-Matti Puro * Jarkko Sonninen * Jouko Valta * Andre Fachat * Andreas Boose * * This file is part of VICE, the Versatile Commodore Emulator. * See README for copyright notice. * * 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. * */ #define DEBUG_MAIN #include "vice.h" #include #include #include #include #ifdef USE_VICE_THREAD #include #endif #include "archdep.h" #include "cmdline.h" #include "console.h" #include "debug.h" #include "drive.h" #include "fullscreen.h" #include "gfxoutput.h" #include "info.h" #include "init.h" #include "initcmdline.h" #include "lib.h" #include "log.h" #include "machine.h" #include "maincpu.h" #include "main.h" #include "mainlock.h" #include "resources.h" #include "screenshot.h" #include "sysfile.h" #include "types.h" #include "uiapi.h" #include "uiactions.h" #include "uihotkeys.h" #include "util.h" #include "version.h" #include "video.h" #include "vsyncapi.h" #ifdef USE_SVN_REVISION #include "svnversion.h" #endif #ifdef DEBUG_MAIN #define DBG(x) log_printf x #else #define DBG(x) #endif /** \brief Console mode requested on the command line * * The command line contained \c -console */ bool console_mode = false; /* FIXME: currently never set to true */ bool video_disabled_mode = false; /** \brief Help was requested on the command line * * The command line contained -?/-h/-help/--help. * * Include "machine.h" to use this variable. */ bool help_requested = false; /** \brief Default setting were requested on the command line * * The command line contained \c -default, which has implications for loading * of configuration and ROM files from certain user directories. */ bool default_settings_requested = false; void main_loop_forever(void); #ifdef USE_VICE_THREAD void *vice_thread_main(void *); static pthread_t vice_thread; static pthread_mutex_t init_lock = PTHREAD_MUTEX_INITIALIZER; #endif /** \brief Size of buffer used to write core team members' names to log/stdout * * 79 characters + 1 byte for '\0'. Assuming a terminal width of 80 characters, * we can only use 79 when calling log_message() since that function adds a * newline to its ouput. */ #define TERM_TMP_SIZE 80 /* ------------------------------------------------------------------------- */ log_t main_log; static void vice_banner(void) { int i, n; const char *program_name; char term_tmp[TERM_TMP_SIZE]; size_t name_len; program_name = archdep_program_name(); /* NOTE: we do NOT use main_log here on purpose, this is so we can output the welcome banner without the "Main:" prefix */ log_message(LOG_DEFAULT, " "); #ifdef USE_SVN_REVISION log_message(LOG_DEFAULT, LOG_COL_LWHITE "*** VICE Version %s, rev %s ***" LOG_COL_OFF, VERSION, VICE_SVN_REV_STRING); #else log_message(LOG_DEFAULT, LOG_COL_LWHITE "*** VICE Version %s ***" LOG_COL_OFF, VERSION); #endif log_message(LOG_DEFAULT, " "); if (log_get_limit() <= LOG_LIMIT_STANDARD) { log_message(LOG_DEFAULT, "This is the condensed log, for the full log use " LOG_COL_LWHITE "--verbose" LOG_COL_OFF " or " LOG_COL_LWHITE "--debug" LOG_COL_OFF "."); log_message(LOG_DEFAULT, " "); } else { if (machine_class == VICE_MACHINE_VSID) { log_message(LOG_DEFAULT, "Welcome to %s, the free portable SID Player.", program_name); } else { log_message(LOG_DEFAULT, "Welcome to %s, the free portable %s Emulator.", program_name, machine_name); } log_message(LOG_DEFAULT, " "); log_message(LOG_DEFAULT, "Current VICE team members:"); n = 0; *term_tmp = 0; for (i = 0; core_team[i].name != NULL; i++) { name_len = strlen(core_team[i].name); /* XXX: reject names that will never fit, for now */ if ((int)name_len + 3 > TERM_TMP_SIZE) { log_warning(LOG_DEFAULT, "%s:%d: name '%s' too large for buffer", __FILE__, __LINE__, core_team[i].name); break; /* this will still write out whatever was in the buffer */ } if (n + (int)name_len + 3 > TERM_TMP_SIZE) { /* +3 for ", \0" */ log_message(LOG_DEFAULT, "%s", term_tmp); strcpy(term_tmp, core_team[i].name); n = (int)name_len; } else { strcat(term_tmp, core_team[i].name); n += (int)name_len; } if (core_team[i + 1].name == NULL) { strcat(term_tmp, "."); } else { strcat(term_tmp, ", "); n += 2; } } log_message(LOG_DEFAULT, "%s", term_tmp); log_message(LOG_DEFAULT, " "); log_message(LOG_DEFAULT, LOG_COL_LWHITE "This is free software with ABSOLUTELY NO WARRANTY." LOG_COL_OFF); log_message(LOG_DEFAULT, LOG_COL_LWHITE "See the \"About VICE\" command for more info." LOG_COL_OFF); log_message(LOG_DEFAULT, " "); } } /* This is the main program entry point. Call this from `main()'. */ int main_program(int argc, char **argv) { int i, n; int reserr; char *cmdline; #ifdef WINDOWS_COMPILE bool no_redirect_streams = false; #endif bool loadconfig = true; char *datadir; #ifdef USE_VICE_THREAD /* * The init lock guarantees that all main thread init outcomes are visible * to the VICE thread. */ pthread_mutex_lock(&init_lock); archdep_thread_init(); mainlock_init(); #endif archdep_set_openmp_wait_policy(); lib_init(); /* create string from the commandline that we can log later */ cmdline = lib_strdup(argv[0]); for (i = 1; i < argc; i++) { char *p; p = cmdline; /* remember old pointer */ cmdline = util_concat(p, " ", argv[i], NULL); lib_free(p); /* free old pointer */ } #ifdef WINDOWS_COMPILE /* make stdin, stdout and stderr available on Windows when compiling with * -mwindows */ for (i = 1; i < argc; i++) { if (strcmp(argv[i], "-no-redirect-streams") == 0) { no_redirect_streams = true; /* printf("%s(): found -no-redirect-streams\n", __func__); */ break; } } if (!no_redirect_streams) { /* printf("%s(): enabling stream redirection\n", __func__); */ archdep_fix_streams(); } else { /* printf("%s(): disabling stream redirection\n", __func__); */ } #endif /* set log level to "normal" here, any log output before would use "debug", and anything after here can use the option(s) on the cmdline */ log_set_limit_early(LOG_LIMIT_STANDARD); /* Check for some options at the beginning of the commandline before initializing the user interface or loading the config file. -default => use default config, do not load any config -config => use specified configuration file -console => no user interface -verbose => more verbose logging -silent => no logging -seed => set the random seed */ DBG(("main:early parse cmdline(argc:%d)", argc)); for (i = 1; i < argc; i++) { if ((!strcmp(argv[i], "-console")) || (!strcmp(argv[i], "--console"))) { console_mode = true; /* video_disabled_mode = 1; Breaks exitscreenshot */ } else if ((!strcmp(argv[i], "-version")) || (!strcmp(argv[i], "--version"))) { #ifdef USE_SVN_REVISION log_message(LOG_DEFAULT, "%s (VICE %s SVN r%d)\n", archdep_program_name(), VERSION, VICE_SVN_REV_NUMBER); #else log_message(LOG_DEFAULT, "%s (VICE %s)\n", archdep_program_name(), VERSION); #endif archdep_program_name_free(); archdep_program_path_free(); lib_free(cmdline); exit(EXIT_SUCCESS); } else if ((!strcmp(argv[i], "-config")) || (!strcmp(argv[i], "--config"))) { if ((i + 1) < argc) { vice_config_file = lib_strdup(argv[++i]); loadconfig = true; } } else if ((!strcmp(argv[i], "-default")) || (!strcmp(argv[i], "--default"))) { loadconfig = false; #ifndef USE_HEADLESSUI /* don't load custom hotkeys file in user config dir if present */ default_settings_requested = 1; #endif } else if ((!strcmp(argv[i], "-verbose")) || (!strcmp(argv[i], "--verbose"))) { log_set_limit_early(LOG_LIMIT_VERBOSE); } else if ((!strcmp(argv[i], "-silent")) || (!strcmp(argv[i], "--silent"))) { log_set_limit_early(LOG_LIMIT_SILENT); } else if ((!strcmp(argv[i], "-debug")) || (!strcmp(argv[i], "--debug"))) { log_set_limit_early(LOG_LIMIT_DEBUG); } else if ((!strcmp(argv[i], "-seed")) || (!strcmp(argv[i], "--seed"))) { if ((i + 1) < argc) { lib_rand_seed(strtoul(argv[++i], NULL, 0)); } } else { break; } } /* remove the already handled items from the commandline, else they will get parsed again later, which causes surprising effects. */ for (n = 1; i < argc; n++, i++) { argv[n] = argv[i]; } argv[n] = NULL; argc = n; /* help is also special, but we want it NOT to be ignored by the main commandline handler */ for (i = 1; i < argc; i++) { if ((!strcmp(argv[i], "-help")) || (!strcmp(argv[i], "--help")) || (!strcmp(argv[i], "-h")) || (!strcmp(argv[i], "-?"))) { help_requested = true; } } DBG(("main:archdep_init(argc:%d)", argc)); if (archdep_init(&argc, argv) != 0) { archdep_startup_log_error("archdep_init failed.\n"); return -1; } DBG(("main:early init")); tick_init(); maincpu_early_init(); machine_setup_context(); drive_setup_context(); machine_early_init(); DBG(("main:early init done")); /* Initialize system file locator. */ sysfile_init(machine_name); /* generic init, first resources, then cmdline options that use them */ if ((init_resources() < 0) || (init_cmdline_options() < 0)) { return -1; } /* KLUDGES: this should really get fixed properly, so it can go into the regular init function(s) */ DBG(("main:early gfxoutput init")); gfxoutput_early_init((int)help_requested); gfxoutput_resources_init(); if (gfxoutput_cmdline_options_init() < 0) { init_cmdline_options_fail("gfxoutput"); return -1; } if (screenshot_cmdline_options_init() < 0) { init_cmdline_options_fail("screenshot"); return -1; } DBG(("main:early gfxoutput init done")); /* Set factory defaults. */ if (resources_set_defaults() < 0) { archdep_startup_log_error("Cannot set defaults.\n"); return -1; } /* Initialize the UI actions system, this needs to happen before the UI * init so the UI code can register handlers */ if (!console_mode && !help_requested) { #ifndef USE_HEADLESSUI ui_actions_init(); /* also initialize the hotkeys resources/cmdline */ ui_hotkeys_resources_init(); ui_hotkeys_cmdline_options_init(); #endif } /* Initialize the user interface. `ui_init_with_args()' might need to handle the command line somehow, so we call it before parsing the options. (e.g. under X11, the `-display' option is handled independently). */ DBG(("main:ui_init(argc:%d)", argc)); if (!console_mode) { ui_init_with_args(&argc, argv); } if ((!help_requested) && (loadconfig)) { /* Load the user's default configuration file. */ reserr = resources_load(NULL); if (reserr < 0 && reserr != RESERR_FILE_NOT_FOUND) { /* The resource file might contain errors, and thus certain resources might have been initialized anyway. */ if (resources_set_defaults() < 0) { archdep_startup_log_error("Cannot set defaults.\n"); return -1; } } } /* FIXME: it should be possible to init the log system much earlier */ DBG(("main:log init")); if (log_init() < 0) { const char *logfile = NULL; /* assuming LogFileName exists */ resources_get_string("LogFileName", &logfile); if (logfile != NULL && *logfile != '\0') { archdep_startup_log_error( "Cannot start logging system, failed to open '%s' for writing", logfile); } else { archdep_startup_log_error("Cannot startup logging system.\n"); } } main_log = log_open("Main"); DBG(("main:initcmdline_check_args(argc:%d)", argc)); if (initcmdline_check_args(argc, argv) < 0) { return -1; } /* Initialize the user interface, 2nd part. */ DBG(("main:uidata_init(argc:%d)", argc)); if (!console_mode && ui_init() < 0) { archdep_startup_log_error("Cannot initialize the UI.\n"); return -1; } /* VICE boot sequence. */ vice_banner(); /* from this point on use main_log ! */ /* lib_free(program_name); */ lib_rand_printseed(main_log); /* log the random seed */ log_message(main_log, "command line was: %s", cmdline); lib_free(cmdline); /* log VICE system file directory */ datadir = archdep_get_vice_datadir(); log_message(main_log, "VICE system file directory: '%s'.", datadir); log_message(main_log, "VICE system file search path: '%s'.", get_system_path()); lib_free(datadir); /* Complete the GUI initialization (after loading the resources and parsing the command-line) if necessary. */ if (/*!console_mode && */video_init() < 0) { return -1; } if (initcmdline_check_psid() < 0) { return -1; } if (init_main() < 0) { return -1; } #ifdef USE_VICE_THREAD { /* * On macOS, pthreads have a default stack size of 512KB. Linux * pthreads use 8MB by default. Since we have code in wic64 that * uses ~1MB temp stack buffers, we explicitly set the VICE thread * stack size to 8MB to bring all platforms in line with Linux. */ pthread_attr_t attr; size_t stacksize = 8 * 1024 * 1024; pthread_attr_init(&attr); pthread_attr_setstacksize(&attr, stacksize); if (pthread_create(&vice_thread, &attr, vice_thread_main, NULL)) { log_fatal(main_log, "failed to launch main thread"); return 1; } } pthread_mutex_unlock(&init_lock); #else /* #ifdef USE_VICE_THREAD */ main_loop_forever(); #endif /* #ifdef USE_VICE_THREAD */ return 0; } extern log_t maincpu_log; /* FIXME: where should this live? */ void main_loop_forever(void) { log_message(maincpu_log, "%s", ""); /* ugly hack to produce a blank log line, but not trigger a warning */ log_message(maincpu_log, "starting at ($FFFC)."); /* This doesn't return. The thread will directly exit when requested. */ maincpu_mainloop(); log_fatal(main_log, "perkele! (THREAD)"); } #ifdef USE_VICE_THREAD void vice_thread_shutdown(void) { if (!vice_thread) { /* We're exiting early in program life, such as when invoked with -help */ return; } /* NOTE: use LOG_DEFAULT here on purpose */ log_message(LOG_DEFAULT, "\n" LOG_COL_LWHITE "Configure Flags" LOG_COL_OFF ":\n%s", CONFIGURE_FLAGS); /* log resources with non default values */ resources_log_active(); /* log the active config as commandline options */ cmdline_log_active(); if (pthread_equal(pthread_self(), vice_thread)) { printf("FIXME! VICE thread is trying to shut itself down directly, this needs to be called from the ui thread for a correct shutdown!\n"); mainlock_initiate_shutdown(); return; } mainlock_initiate_shutdown(); pthread_join(vice_thread, NULL); log_verbose(main_log, "VICE thread has been joined."); } void *vice_thread_main(void *unused) { /* Let the mainlock system know which thread is the vice thread */ mainlock_set_vice_thread(); /* * main_loop_forever() does not return, so we call archdep_thread_shutdown() * in the mainlock system which manages a direct pthread based thread exit. */ main_loop_forever(); return NULL; } #endif /* #ifdef USE_VICE_THREAD */