emacs.c 70.6 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Fully extensible Emacs, running on Unix, intended for GNU.
2

3 4
Copyright (C) 1985-1987, 1993-1995, 1997-1999, 2001-2013 Free Software
Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

GNU Emacs 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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24 25 26 27
#include <errno.h>
#include <stdio.h>

#include <sys/types.h>
#include <sys/file.h>
28 29
#include <unistd.h>

Paul Eggert's avatar
Paul Eggert committed
30
#include <close-stream.h>
31 32
#include <ignore-value.h>

33 34
#include "lisp.h"

35 36
#ifdef WINDOWSNT
#include <fcntl.h>
37
#include <sys/socket.h>
38
#include "w32.h"
Daniel Colascione's avatar
Daniel Colascione committed
39 40 41
#include "w32heap.h"
#endif

42
#if defined WINDOWSNT || defined HAVE_NTGUI
Daniel Colascione's avatar
Daniel Colascione committed
43 44
#include "w32select.h"
#include "w32font.h"
45
#include "w32common.h"
Daniel Colascione's avatar
Daniel Colascione committed
46 47
#endif

48
#if defined CYGWIN
Daniel Colascione's avatar
Daniel Colascione committed
49
#include "cygw32.h"
50 51
#endif

52 53 54 55
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

56 57 58 59 60
#ifdef NS_IMPL_GNUSTEP
/* At least under Debian, GSConfig is in a subdirectory.  --Stef  */
#include <GNUstepBase/GSConfig.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
61
#include "commands.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
62
#include "intervals.h"
63
#include "character.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
64
#include "buffer.h"
Stefan Monnier's avatar
Stefan Monnier committed
65
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
66

67
#include "systty.h"
68
#include "atimer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
69
#include "blockinput.h"
70
#include "syssignal.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
71
#include "process.h"
72
#include "frame.h"
73
#include "termhooks.h"
Andreas Schwab's avatar
Andreas Schwab committed
74
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
75
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
76

Ted Zlatanov's avatar
Ted Zlatanov committed
77 78 79 80
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

81 82 83 84 85 86
#if (defined PROFILING \
     && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
# include <sys/gmon.h>
extern void moncontrol (int mode);
#endif

87 88 89 90
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif

91 92 93 94 95
#ifdef HAVE_SETRLIMIT
#include <sys/time.h>
#include <sys/resource.h>
#endif

96 97 98 99
#ifdef HAVE_PERSONALITY_LINUX32
#include <sys/personality.h>
#endif

100
static const char emacs_version[] = VERSION;
101
static const char emacs_copyright[] = COPYRIGHT;
102

103 104
/* Empty lisp strings.  To avoid having to build any others.  */
Lisp_Object empty_unibyte_string, empty_multibyte_string;
Stefan Monnier's avatar
Stefan Monnier committed
105

106 107 108 109 110
#ifdef WINDOWSNT
/* Cache for externally loaded libraries.  */
Lisp_Object Vlibrary_cache;
#endif

111 112 113 114
/* Set after Emacs has started up the first time.
   Prevents reinitialization of the Lisp world and keymaps
   on subsequent starts.  */
bool initialized;
Jim Blandy's avatar
Jim Blandy committed
115

116 117 118 119
#ifdef DARWIN_OS
extern void unexec_init_emacs_zone (void);
#endif

120 121 122
#ifdef DOUG_LEA_MALLOC
/* Preserves a pointer to the memory allocated that copies that
   static data inside glibc's malloc.  */
123
static void *malloc_state_ptr;
124
/* From glibc, a routine that returns a copy of the malloc internal state.  */
125
extern void *malloc_get_state (void);
126
/* From glibc, a routine that overwrites the malloc internal state.  */
127
extern int malloc_set_state (void*);
128
/* True if the MALLOC_CHECK_ environment variable was set while
129
   dumping.  Used to work around a bug in glibc's malloc.  */
130
static bool malloc_using_checking;
131 132
#elif defined HAVE_PTHREAD && !defined SYSTEM_MALLOC
extern void malloc_enable_thread (void);
133 134
#endif

135 136
Lisp_Object Qfile_name_handler_alist;

Glenn Morris's avatar
Glenn Morris committed
137 138
Lisp_Object Qrisky_local_variable;

139 140
Lisp_Object Qkill_emacs;
static Lisp_Object Qkill_emacs_hook;
141

142
/* If true, Emacs should not attempt to use a window-specific code,
Pavel Janík's avatar
Pavel Janík committed
143
   but instead should use the virtual terminal under which it was started.  */
144
bool inhibit_window_system;
Jim Blandy's avatar
Jim Blandy committed
145

146
/* If true, a filter or a sentinel is running.  Tested to save the match
Pavel Janík's avatar
Pavel Janík committed
147
   data on the first attempt to change it inside asynchronous code.  */
148
bool running_asynch_code;
149

Juanma Barranquero's avatar
Juanma Barranquero committed
150
#if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
151 152
/* If true, -d was specified, meaning we're using some window system.  */
bool display_arg;
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157 158
#endif

/* An address near the bottom of the stack.
   Tells GC how to save a copy of the stack.  */
char *stack_bottom;

159
#if defined (DOUG_LEA_MALLOC) || defined (GNU_LINUX)
160 161
/* The address where the heap starts (from the first sbrk (0) call).  */
static void *my_heap_start;
162
#endif
163

164
#ifdef GNU_LINUX
165
/* The gap between BSS end and heap start as far as we can tell.  */
166 167
static uprintmax_t heap_bss_diff;
#endif
168

169 170 171 172 173 174 175 176 177 178 179 180
/* To run as a daemon under Cocoa or Windows, we must do a fork+exec,
   not a simple fork.

   On Cocoa, CoreFoundation lib fails in forked process:
   http://developer.apple.com/ReleaseNotes/
   CoreFoundation/CoreFoundation.html)

   On Windows, a Cygwin fork child cannot access the USER subsystem.

   We mark being in the exec'd process by a daemon name argument of
   form "--daemon=\nFD0,FD1\nNAME" where FD are the pipe file descriptors,
   NAME is the original daemon name, if any. */
181
#if defined NS_IMPL_COCOA || (defined HAVE_NTGUI && defined CYGWIN)
182 183 184
# define DAEMON_MUST_EXEC
#endif

185 186
/* True means running Emacs without interactive terminal.  */
bool noninteractive;
Jim Blandy's avatar
Jim Blandy committed
187

188 189
/* True means remove site-lisp directories from load-path.  */
bool no_site_lisp;
190

191 192
/* Name for the server started by the daemon.*/
static char *daemon_name;
193

194 195
/* Pipe used to send exit notification to the daemon parent at
   startup.  */
196
int daemon_pipe[2];
197

198 199 200
/* Save argv and argc.  */
char **initial_argv;
int initial_argc;
201

202
static void sort_args (int argc, char **argv);
203
static void syms_of_emacs (void);
Gerd Moellmann's avatar
Gerd Moellmann committed
204

Kenichi Handa's avatar
Kenichi Handa committed
205 206
/* MSVC needs each string be shorter than 2048 bytes, so the usage
   strings below are split to not overflow this limit.  */
207
#define USAGE1 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
208 209 210 211 212 213
Usage: %s [OPTION-OR-FILENAME]...\n\
\n\
Run Emacs, the extensible, customizable, self-documenting real-time\n\
display editor.  The recommended way to start Emacs for normal editing\n\
is with no options at all.\n\
\n\
214
Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
215 216 217 218
read the main documentation for these command-line arguments.\n\
\n\
Initialization options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
219
--batch                     do not do interactive display; implies -q\n\
220
--chdir DIR                 change to directory DIR\n\
Glenn Morris's avatar
Glenn Morris committed
221
--daemon                    start a server in the background\n\
Kenichi Handa's avatar
Kenichi Handa committed
222 223 224 225 226 227
--debug-init                enable Emacs Lisp debugger for init file\n\
--display, -d DISPLAY       use X server DISPLAY\n\
--no-desktop                do not load a saved desktop\n\
--no-init-file, -q          load neither ~/.emacs nor default.el\n\
--no-shared-memory, -nl     do not use shared memory\n\
--no-site-file              do not load site-start.el\n\
228
--no-site-lisp, -nsl        do not add site-lisp directories to load-path\n\
Kenichi Handa's avatar
Kenichi Handa committed
229
--no-splash                 do not display a splash screen on startup\n\
230
--no-window-system, -nw     do not communicate with X, ignoring $DISPLAY\n\
231 232
--quick, -Q                 equivalent to:\n\
                              -q --no-site-file --no-site-lisp --no-splash\n\
Kenichi Handa's avatar
Kenichi Handa committed
233 234 235 236 237 238
--script FILE               run FILE as an Emacs Lisp script\n\
--terminal, -t DEVICE       use DEVICE for terminal I/O\n\
--user, -u USER             load ~USER/.emacs instead of your own\n\
\n%s"

#define USAGE2 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
239 240
Action options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
241
FILE                    visit FILE using find-file\n\
242 243
+LINE                   go to line LINE in next FILE\n\
+LINE:COLUMN            go to line LINE, column COLUMN, in next FILE\n\
Kenichi Handa's avatar
Kenichi Handa committed
244 245 246 247 248 249 250 251 252 253
--directory, -L DIR     add DIR to variable load-path\n\
--eval EXPR             evaluate Emacs Lisp expression EXPR\n\
--execute EXPR          evaluate Emacs Lisp expression EXPR\n\
--file FILE             visit FILE using find-file\n\
--find-file FILE        visit FILE using find-file\n\
--funcall, -f FUNC      call Emacs Lisp function FUNC with no arguments\n\
--insert FILE           insert contents of FILE into current buffer\n\
--kill                  exit without asking for confirmation\n\
--load, -l FILE         load Emacs Lisp FILE using the load function\n\
--visit FILE            visit FILE using find-file\n\
254 255
\n"

Kenichi Handa's avatar
Kenichi Handa committed
256
#define USAGE3 "\
257
Display options:\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
258
\n\
Kenichi Handa's avatar
Kenichi Handa committed
259
--background-color, -bg COLOR   window background color\n\
260 261
--basic-display, -D             disable many display features;\n\
                                  used for debugging Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
262 263
--border-color, -bd COLOR       main border color\n\
--border-width, -bw WIDTH       width of main border\n\
264
--color, --color=MODE           override color mode for character terminals;\n\
265 266
                                  MODE defaults to `auto', and\n\
                                  can also be `never', `always',\n\
Kenichi Handa's avatar
Kenichi Handa committed
267 268 269 270 271
                                  or a mode name like `ansi8'\n\
--cursor-color, -cr COLOR       color of the Emacs cursor indicating point\n\
--font, -fn FONT                default font; must be fixed-width\n\
--foreground-color, -fg COLOR   window foreground color\n\
--fullheight, -fh               make the first frame high as the screen\n\
272
--fullscreen, -fs               make the first frame fullscreen\n\
Kenichi Handa's avatar
Kenichi Handa committed
273
--fullwidth, -fw                make the first frame wide as the screen\n\
274
--maximized, -mm                make the first frame maximized\n\
Kenichi Handa's avatar
Kenichi Handa committed
275
--geometry, -g GEOMETRY         window geometry\n\
Jan Djärv's avatar
Jan Djärv committed
276
--no-bitmap-icon, -nbi          do not use picture of gnu for Emacs icon\n\
Kenichi Handa's avatar
Kenichi Handa committed
277 278 279 280 281
--iconic                        start Emacs in iconified state\n\
--internal-border, -ib WIDTH    width between text and main border\n\
--line-spacing, -lsp PIXELS     additional space to put between lines\n\
--mouse-color, -ms COLOR        mouse cursor color in Emacs window\n\
--name NAME                     title for initial Emacs frame\n\
282
--no-blinking-cursor, -nbc      disable blinking cursor\n\
Kenichi Handa's avatar
Kenichi Handa committed
283 284 285 286
--reverse-video, -r, -rv        switch foreground and background\n\
--title, -T TITLE               title for initial Emacs frame\n\
--vertical-scroll-bars, -vb     enable vertical scroll bars\n\
--xrm XRESOURCES                set additional X resources\n\
Jan Djärv's avatar
Jan Djärv committed
287
--parent-id XID                 set parent window\n\
Kenichi Handa's avatar
Kenichi Handa committed
288 289
--help                          display this help and exit\n\
--version                       output version information and exit\n\
290 291 292
\n"

#define USAGE4 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
293 294 295 296 297 298
You can generally also specify long option names with a single -; for\n\
example, -batch as well as --batch.  You can use any unambiguous\n\
abbreviation for a --option.\n\
\n\
Various environment variables and window system resources also affect\n\
Emacs' operation.  See the main documentation.\n\
299
\n\
300
Report bugs to bug-gnu-emacs@gnu.org.  First, please see the Bugs\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
301 302
section of the Emacs manual or the file BUGS.\n"

Jim Blandy's avatar
Jim Blandy committed
303

304 305
/* True if handling a fatal error already.  */
bool fatal_error_in_progress;
Jim Blandy's avatar
Jim Blandy committed
306

307 308 309
#ifdef HAVE_NS
/* NS autrelease pool, for memory management.  */
static void *ns_pool;
310 311
#endif

312 313 314 315 316 317 318
#if !HAVE_SETLOCALE
static char *
setlocale (int cat, char const *locale)
{
  return 0;
}
#endif
319

320

321 322 323
/* Report a fatal error due to signal SIG, output a backtrace of at
   most BACKTRACE_LIMIT lines, and exit.  */
_Noreturn void
324
terminate_due_to_signal (int sig, int backtrace_limit)
325
{
Paul Eggert's avatar
Paul Eggert committed
326
  signal (sig, SIG_DFL);
327
  totally_unblock_input ();
328

Jim Blandy's avatar
Jim Blandy committed
329
  /* If fatal error occurs in code below, avoid infinite recursion.  */
330 331 332
  if (! fatal_error_in_progress)
    {
      fatal_error_in_progress = 1;
Jim Blandy's avatar
Jim Blandy committed
333

334
      if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
335 336
        Fkill_emacs (make_number (sig));

337
      shut_down_emacs (sig, Qnil);
338
      emacs_backtrace (backtrace_limit);
339
    }
Jim Blandy's avatar
Jim Blandy committed
340

341
  /* Signal the same code; this time it will really be fatal.
342 343
     Since we're in a signal handler, the signal is blocked, so we
     have to unblock it if we want to really receive it.  */
344
#ifndef MSDOS
Paul Eggert's avatar
Paul Eggert committed
345 346 347
  {
    sigset_t unblocked;
    sigemptyset (&unblocked);
348
    sigaddset (&unblocked, sig);
Paul Eggert's avatar
Paul Eggert committed
349 350
    pthread_sigmask (SIG_UNBLOCK, &unblocked, 0);
  }
351
#endif
352

353
  emacs_raise (sig);
354 355 356

  /* This shouldn't be executed, but it prevents a warning.  */
  exit (1);
Jim Blandy's avatar
Jim Blandy committed
357 358
}

Pavel Janík's avatar
Pavel Janík committed
359
/* Code for dealing with Lisp access to the Unix command line.  */
Jim Blandy's avatar
Jim Blandy committed
360

Andreas Schwab's avatar
Andreas Schwab committed
361
static void
362
init_cmdargs (int argc, char **argv, int skip_args)
Jim Blandy's avatar
Jim Blandy committed
363 364
{
  register int i;
365
  Lisp_Object name, dir, handler;
366
  ptrdiff_t count = SPECPDL_INDEX ();
367
  Lisp_Object raw_name;
Jim Blandy's avatar
Jim Blandy committed
368

369 370 371
  initial_argv = argv;
  initial_argc = argc;

372 373 374 375
  raw_name = build_string (argv[0]);

  /* Add /: to the front of the name
     if it would otherwise be treated as magic.  */
376 377
  handler = Ffind_file_name_handler (raw_name, Qt);
  if (! NILP (handler))
378 379 380 381 382
    raw_name = concat2 (build_string ("/:"), raw_name);

  Vinvocation_name = Ffile_name_nondirectory (raw_name);
  Vinvocation_directory = Ffile_name_directory (raw_name);

383 384 385 386 387 388
  /* If we got no directory in argv[0], search PATH to find where
     Emacs actually came from.  */
  if (NILP (Vinvocation_directory))
    {
      Lisp_Object found;
      int yes = openp (Vexec_path, Vinvocation_name,
389
		       Vexec_suffixes, &found, make_number (X_OK));
390
      if (yes == 1)
391 392 393
	{
	  /* Add /: to the front of the name
	     if it would otherwise be treated as magic.  */
394 395
	  handler = Ffind_file_name_handler (found, Qt);
	  if (! NILP (handler))
396 397 398
	    found = concat2 (build_string ("/:"), found);
	  Vinvocation_directory = Ffile_name_directory (found);
	}
399
    }
400

401 402
  if (!NILP (Vinvocation_directory)
      && NILP (Ffile_name_absolute_p (Vinvocation_directory)))
403 404
    /* Emacs was started with relative path, like ./emacs.
       Make it absolute.  */
405 406
    Vinvocation_directory = Fexpand_file_name (Vinvocation_directory, Qnil);

407 408 409 410 411
  Vinstallation_directory = Qnil;

  if (!NILP (Vinvocation_directory))
    {
      dir = Vinvocation_directory;
412 413 414 415 416 417 418 419 420 421
#ifdef WINDOWSNT
      /* If we are running from the build directory, set DIR to the
	 src subdirectory of the Emacs tree, like on Posix
	 platforms.  */
      if (SBYTES (dir) > sizeof ("/i386/") - 1
	  && 0 == strcmp (SSDATA (dir) + SBYTES (dir) - sizeof ("/i386/") + 1,
			  "/i386/"))
	dir = Fexpand_file_name (build_string ("../.."), dir);
#else  /* !WINDOWSNT */
#endif
422 423 424
      name = Fexpand_file_name (Vinvocation_name, dir);
      while (1)
	{
425
	  Lisp_Object tem, lib_src_exists;
426 427
	  Lisp_Object etc_exists, info_exists;

428 429 430 431 432
	  /* See if dir contains subdirs for use by Emacs.
	     Check for the ones that would exist in a build directory,
	     not including lisp and info.  */
	  tem = Fexpand_file_name (build_string ("lib-src"), dir);
	  lib_src_exists = Ffile_exists_p (tem);
433

434
#ifdef MSDOS
435 436 437 438 439
	  /* MSDOS installations frequently remove lib-src, but we still
	     must set installation-directory, or else info won't find
	     its files (it uses the value of installation-directory).  */
	  tem = Fexpand_file_name (build_string ("info"), dir);
	  info_exists = Ffile_exists_p (tem);
440 441 442
#else
	  info_exists = Qnil;
#endif
443 444

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
445
	    {
446 447 448
	      tem = Fexpand_file_name (build_string ("etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
449
		{
450 451 452
		  Vinstallation_directory
		    = Ffile_name_as_directory (dir);
		  break;
453 454 455 456
		}
	    }

	  /* See if dir's parent contains those subdirs.  */
457 458
	  tem = Fexpand_file_name (build_string ("../lib-src"), dir);
	  lib_src_exists = Ffile_exists_p (tem);
459

460 461 462

#ifdef MSDOS
	  /* See the MSDOS commentary above.  */
463 464
	  tem = Fexpand_file_name (build_string ("../info"), dir);
	  info_exists = Ffile_exists_p (tem);
465 466 467
#else
	  info_exists = Qnil;
#endif
468 469

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
470
	    {
471 472 473
	      tem = Fexpand_file_name (build_string ("../etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
474
		{
475 476 477 478
		  tem = Fexpand_file_name (build_string (".."), dir);
		  Vinstallation_directory
		    = Ffile_name_as_directory (tem);
		  break;
479 480 481 482 483 484 485 486
		}
	    }

	  /* If the Emacs executable is actually a link,
	     next try the dir that the link points into.  */
	  tem = Ffile_symlink_p (name);
	  if (!NILP (tem))
	    {
487
	      name = Fexpand_file_name (tem, dir);
488 489 490 491 492 493 494
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
495 496 497 498 499
  Vcommand_line_args = Qnil;

  for (i = argc - 1; i >= 0; i--)
    {
      if (i == 0 || i > skip_args)
500 501 502
	/* For the moment, we keep arguments as is in unibyte strings.
	   They are decoded in the function command-line after we know
	   locale-coding-system.  */
Jim Blandy's avatar
Jim Blandy committed
503
	Vcommand_line_args
504
	  = Fcons (make_unibyte_string (argv[i], strlen (argv[i])),
505
		   Vcommand_line_args);
Jim Blandy's avatar
Jim Blandy committed
506
    }
507 508

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
509
}
510 511

DEFUN ("invocation-name", Finvocation_name, Sinvocation_name, 0, 0, 0,
Pavel Janík's avatar
Pavel Janík committed
512 513
       doc: /* Return the program name that was used to run Emacs.
Any directory names are omitted.  */)
514
  (void)
515 516 517 518
{
  return Fcopy_sequence (Vinvocation_name);
}

519
DEFUN ("invocation-directory", Finvocation_directory, Sinvocation_directory,
Pavel Janík's avatar
Pavel Janík committed
520 521
       0, 0, 0,
       doc: /* Return the directory name in which the Emacs executable was located.  */)
522
  (void)
523 524 525 526
{
  return Fcopy_sequence (Vinvocation_directory);
}

Jim Blandy's avatar
Jim Blandy committed
527

528 529 530
#ifdef HAVE_TZSET
/* A valid but unlikely value for the TZ environment value.
   It is OK (though a bit slower) if the user actually chooses this value.  */
531
static char const dump_tz[] = "UtC0";
532 533
#endif

Karl Heuer's avatar
Karl Heuer committed
534 535 536 537 538 539 540 541 542
/* Test whether the next argument in ARGV matches SSTR or a prefix of
   LSTR (at least MINLEN characters).  If so, then if VALPTR is non-null
   (the argument is supposed to have a value) store in *VALPTR either
   the next argument or the portion of this one after the equal sign.
   ARGV is read starting at position *SKIPPTR; this index is advanced
   by the number of arguments used.

   Too bad we can't just use getopt for all of this, but we don't have
   enough information to do it right.  */
543

544
static bool
545 546
argmatch (char **argv, int argc, const char *sstr, const char *lstr,
          int minlen, char **valptr, int *skipptr)
Karl Heuer's avatar
Karl Heuer committed
547
{
548
  char *p = NULL;
549
  ptrdiff_t arglen;
550 551 552 553 554 555 556
  char *arg;

  /* Don't access argv[argc]; give up in advance.  */
  if (argc <= *skipptr + 1)
    return 0;

  arg = argv[*skipptr+1];
Karl Heuer's avatar
Karl Heuer committed
557 558 559 560 561 562 563 564 565 566 567 568 569
  if (arg == NULL)
    return 0;
  if (strcmp (arg, sstr) == 0)
    {
      if (valptr != NULL)
	{
	  *valptr = argv[*skipptr+2];
	  *skipptr += 2;
	}
      else
	*skipptr += 1;
      return 1;
    }
570
  arglen = (valptr != NULL && (p = strchr (arg, '=')) != NULL
Karl Heuer's avatar
Karl Heuer committed
571
	    ? p - arg : strlen (arg));
572
  if (lstr == 0 || arglen < minlen || strncmp (arg, lstr, arglen) != 0)
Karl Heuer's avatar
Karl Heuer committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
    return 0;
  else if (valptr == NULL)
    {
      *skipptr += 1;
      return 1;
    }
  else if (p != NULL)
    {
      *valptr = p+1;
      *skipptr += 1;
      return 1;
    }
  else if (argv[*skipptr+2] != NULL)
    {
      *valptr = argv[*skipptr+2];
      *skipptr += 2;
      return 1;
    }
  else
    {
      return 0;
    }
}

597
#ifdef DOUG_LEA_MALLOC
Jim Blandy's avatar
Jim Blandy committed
598

599 600 601 602 603
/* malloc can be invoked even before main (e.g. by the dynamic
   linker), so the dumped malloc state must be restored as early as
   possible using this special hook.  */

static void
604
malloc_initialize_hook (void)
605
{
606 607
  if (initialized)
    {
608 609 610
      if (!malloc_using_checking)
	/* Work around a bug in glibc's malloc.  MALLOC_CHECK_ must be
	   ignored if the heap to be restored was constructed without
611 612 613 614
	   malloc checking.  Can't use unsetenv, since that calls malloc.  */
	{
	  char **p;

615
	  for (p = environ; p && *p; p++)
616 617 618 619 620 621 622 623
	    if (strncmp (*p, "MALLOC_CHECK_=", 14) == 0)
	      {
		do
		  *p = p[1];
		while (*++p);
		break;
	      }
	}
624

625
      malloc_set_state (malloc_state_ptr);
626
#ifndef XMALLOC_OVERRUN_CHECK
627
      free (malloc_state_ptr);
628
#endif
629
    }
630
  else
631 632 633 634 635
    {
      if (my_heap_start == 0)
        my_heap_start = sbrk (0);
      malloc_using_checking = getenv ("MALLOC_CHECK_") != NULL;
    }
636 637
}

638
void (*__malloc_initialize_hook) (void) EXTERNALLY_VISIBLE = malloc_initialize_hook;
639 640 641

#endif /* DOUG_LEA_MALLOC */

Paul Eggert's avatar
Paul Eggert committed
642 643 644 645 646 647 648 649
/* Close standard output and standard error, reporting any write
   errors as best we can.  This is intended for use with atexit.  */
static void
close_output_streams (void)
{
  if (close_stream (stdout) != 0)
    {
      fprintf (stderr, "Write error to standard output: %s\n",
Paul Eggert's avatar
Paul Eggert committed
650
	       strerror (errno));
Paul Eggert's avatar
Paul Eggert committed
651 652 653 654 655 656 657
      fflush (stderr);
      _exit (EXIT_FAILURE);
    }

   if (close_stream (stderr) != 0)
     _exit (EXIT_FAILURE);
}
658

659 660
/* ARGSUSED */
int
Dan Nicolaescu's avatar
Dan Nicolaescu committed
661
main (int argc, char **argv)
662
{
663
#if GC_MARK_STACK
664 665
  Lisp_Object dummy;
#endif
666
  char stack_bottom_variable;
667
  bool do_initial_setlocale;
668
  bool dumping;
669 670 671 672
  int skip_args = 0;
#ifdef HAVE_SETRLIMIT
  struct rlimit rlim;
#endif
673
  bool no_loadup = 0;
674
  char *junk = 0;
675
  char *dname_arg = 0;
676
#ifdef DAEMON_MUST_EXEC
677
  char dname_arg2[80];
678
#endif
679
  char *ch_to_dir;
680

681
#if GC_MARK_STACK
682 683 684
  stack_base = &dummy;
#endif

Ken Brown's avatar
Ken Brown committed
685
#ifdef G_SLICE_ALWAYS_MALLOC
686
  /* This is used by the Cygwin build.  */
687
  xputenv ("G_SLICE=always-malloc");
688 689
#endif

690
#ifdef GNU_LINUX
691 692 693 694 695 696 697 698 699 700
  if (!initialized)
    {
      extern char my_endbss[];
      extern char *my_endbss_static;

      if (my_heap_start == 0)
        my_heap_start = sbrk (0);

      heap_bss_diff = (char *)my_heap_start - max (my_endbss, my_endbss_static);
    }
701
#endif
702

703 704 705 706 707 708 709
#if defined WINDOWSNT || defined HAVE_NTGUI
  /* Set global variables used to detect Windows version.  Do this as
     early as possible.  (unexw32.c calls this function as well, but
     the additional call here is harmless.) */
  cache_system_info ();
#endif

710 711 712 713 714
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

715 716
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
#ifdef DARWIN_OS
717 718 719 720
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

Paul Eggert's avatar
Paul Eggert committed
721 722
  atexit (close_output_streams);

723
  sort_args (argc, argv);
724 725
  argc = 0;
  while (argv[argc]) argc++;
726

727
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
728
    {
729 730
      const char *version, *copyright;
      if (initialized)
731
	{
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
	  Lisp_Object tem, tem2;
	  tem = Fsymbol_value (intern_c_string ("emacs-version"));
	  tem2 = Fsymbol_value (intern_c_string ("emacs-copyright"));
	  if (!STRINGP (tem))
	    {
	      fprintf (stderr, "Invalid value of `emacs-version'\n");
	      exit (1);
	    }
	  if (!STRINGP (tem2))
	    {
	      fprintf (stderr, "Invalid value of `emacs-copyright'\n");
	      exit (1);
	    }
	  else
	    {
747 748
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
749
	    }
750
	}
751 752
      else
	{
753 754
	  version = emacs_version;
	  copyright = emacs_copyright;
755
	}
756 757 758 759 760 761 762 763
      printf ("GNU Emacs %s\n", version);
      printf ("%s\n", copyright);
      printf ("GNU Emacs comes with ABSOLUTELY NO WARRANTY.\n");
      printf ("You may redistribute copies of Emacs\n");
      printf ("under the terms of the GNU General Public License.\n");
      printf ("For more information about these matters, ");
      printf ("see the file named COPYING.\n");
      exit (0);
764
    }
765 766 767 768 769 770 771 772

  if (argmatch (argv, argc, "-chdir", "--chdir", 4, &ch_to_dir, &skip_args))
    if (chdir (ch_to_dir) == -1)
      {
	fprintf (stderr, "%s: Can't chdir to %s: %s\n",
		 argv[0], ch_to_dir, strerror (errno));
	exit (1);
      }
773

774 775
  dumping = !initialized && (strcmp (argv[argc - 1], "dump") == 0
			     || strcmp (argv[argc - 1], "bootstrap") == 0);
776

777
#ifdef HAVE_PERSONALITY_LINUX32
778
  if (dumping && ! getenv ("EMACS_HEAP_EXEC"))
779
    {
780
      /* Set this so we only do this once.  */
781
      xputenv ("EMACS_HEAP_EXEC=true");
782

783 784
      /* A flag to turn off address randomization which is introduced
         in linux kernel shipped with fedora core 4 */
785
#define ADD_NO_RANDOMIZE 0x0040000
786
      personality (PER_LINUX32 | ADD_NO_RANDOMIZE);
787 788
#undef  ADD_NO_RANDOMIZE

789
      execvp (argv[0], argv);
790

791 792
      /* If the exec fails, try to dump anyway.  */
      perror ("execvp");
793 794 795
    }
#endif /* HAVE_PERSONALITY_LINUX32 */

796
#if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK)
797 798 799 800 801 802 803 804
  /* Extend the stack space available.
     Don't do that if dumping, since some systems (e.g. DJGPP)
     might define a smaller stack limit at that time.  */
  if (1
#ifndef CANNOT_DUMP
      && (!noninteractive || initialized)
#endif
      && !getrlimit (RLIMIT_STACK, &rlim))
805
    {
806
      long newlim;
807
      extern size_t re_max_failures;
808 809 810 811 812 813 814 815
      /* Approximate the amount regex.c needs per unit of re_max_failures.  */
      int ratio = 20 * sizeof (char *);
      /* Then add 33% to cover the size of the smaller stacks that regex.c
	 successively allocates and discards, on its way to the maximum.  */
      ratio += ratio / 3;
      /* Add in some extra to cover
	 what we're likely to use for other reasons.  */
      newlim = re_max_failures * ratio + 200000;
816 817 818 819 820
#ifdef __NetBSD__
      /* NetBSD (at least NetBSD 1.2G and former) has a bug in its
       stack allocation routine for new process that the allocation
       fails if stack limit is not on page boundary.  So, round up the
       new limit to page boundary.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
821
      newlim = (newlim + getpagesize () - 1) / getpagesize () * getpagesize ();
822
#endif
823
      if (newlim > rlim.rlim_max)
824 825
	{
	  newlim = rlim.rlim_max;
826 827
	  /* Don't let regex.c overflow the stack we have.  */
	  re_max_failures = (newlim - 200000) / ratio;
828
	}
829 830 831
      if (rlim.rlim_cur < newlim)
	rlim.rlim_cur = newlim;

832 833
      setrlimit (RLIMIT_STACK, &rlim);
    }
834
#endif /* HAVE_SETRLIMIT and RLIMIT_STACK */
835

Jim Blandy's avatar
Jim Blandy committed
836 837 838 839
  /* Record (approximately) where the stack begins.  */
  stack_bottom = &stack_bottom_variable;

  clearerr (stdin);
840

Jim Blandy's avatar
Jim Blandy committed
841
#ifndef SYSTEM_MALLOC
842 843
  /* Arrange to get warning messages as memory fills up.  */
  memory_warnings (0, malloc_warning);
844

845
  /* Call malloc at least once, to run malloc_initialize_hook.
846 847
     Also call realloc and free for consistency.  */
  free (realloc (malloc (4), 4));
848

Jim Blandy's avatar
Jim Blandy committed
849 850
#endif	/* not SYSTEM_MALLOC */

851
#if defined (MSDOS) || defined (WINDOWSNT)
852 853 854
  /* We do all file input/output as binary files.  When we need to translate
     newlines, we do that manually.  */
  _fmode = O_BINARY;
855
#endif /* MSDOS || WINDOWSNT */
856

857
#ifdef MSDOS
858 859 860 861 862 863 864
  if (!isatty (fileno (stdin)))
    setmode (fileno (stdin), O_BINARY);
  if (!isatty (fileno (stdout)))
    {
      fflush (stdout);
      setmode (fileno (stdout), O_BINARY);
    }
865 866
#endif /* MSDOS */

867 868 869 870 871 872 873 874 875 876 877 878 879 880
  /* Skip initial setlocale if LC_ALL is "C", as it's not needed in that case.
     The build procedure uses this while dumping, to ensure that the
     dumped Emacs does not have its system locale tables initialized,
     as that might cause screwups when the dumped Emacs starts up.  */
  {
    char *lc_all = getenv ("LC_ALL");
    do_initial_setlocale = ! lc_all || strcmp (lc_all, "C");
  }

  /* Set locale now, so that initial error messages are localized properly.
     fixup_locale must wait until later, since it builds strings.  */
  if (do_initial_setlocale)
    setlocale (LC_ALL, "");

Jim Blandy's avatar
Jim Blandy committed
881 882
  inhibit_window_system = 0;

Pavel Janík's avatar
Pavel Janík committed
883
  /* Handle the -t switch, which specifies filename to use as terminal.  */
884 885 886 887 888 889
  while (1)
    {
      char *term;
      if (argmatch (argv, argc, "-t", "--terminal", 4, &term, &skip_args))
	{
	  int result;
890 891 892
	  emacs_close (0);
	  emacs_close (1);
	  result = emacs_open (term, O_RDWR, 0);
893
	  if (result < 0 || fcntl (0, F_DUPFD_CLOEXEC, 1) < 0)
894 895
	    {
	      char *errstring = strerror (errno);
896
	      fprintf (stderr, "%s: %s: %s\n", argv[0], term, errstring);
897 898 899 900
	      exit (1);
	    }
	  if (! isatty (0))
	    {
901
	      fprintf (stderr, "%s: %s: not a tty\n", argv[0], term);
902 903 904
	      exit (1);
	    }
	  fprintf (stderr, "Using %s\n", term);
905
#ifdef HAVE_WINDOW_SYSTEM
906
	  inhibit_window_system = 1; /* -t => -nw */
Jim Blandy's avatar
Jim Blandy committed
907
#endif
908 909 910 911 912
	}
      else
	break;
    }

913
  /* Command line option --no-windows is deprecated and thus not mentioned
Paul Eggert's avatar
Paul Eggert committed
914
     in the manual and usage information.  */
915 916
  if (argmatch (argv, argc, "-nw", "--no-window-system", 6, NULL, &skip_args)
      || argmatch (argv, argc, "-nw", "--no-windows", 6, NULL, &skip_args))
Karl Heuer's avatar
Karl Heuer committed
917
    inhibit_window_system = 1;
Jim Blandy's avatar
Jim Blandy committed
918

Karl Heuer's avatar
Karl Heuer committed
919
  /* Handle the -batch switch, which means don't do interactive display.  */
Jim Blandy's avatar
Jim Blandy committed
920
  noninteractive = 0;
921
  if (argmatch (argv, argc, "-batch", "--batch", 5, NULL, &skip_args))
922 923 924 925
    {
      noninteractive = 1;
      Vundo_outer_limit = Qnil;
    }
926 927 928
  if (argmatch (argv, argc, "-script", "--script", 3, &junk, &skip_args))
    {
      noninteractive = 1;	/* Set batch mode.  */
929
      /* Convert --script to -scriptload, un-skip it, and sort again
930
	 so that it will be handled in proper sequence.  */
931
      /* FIXME broken for --script=FILE - is that supposed to work?  */
932
      argv[skip_args - 1] = (char *) "-scriptload";
933 934 935
      skip_args -= 2;
      sort_args (argc, argv);
    }
Karl Heuer's avatar
Karl Heuer committed
936

Pavel Janík's avatar
Pavel Janík committed
937
  /* Handle the --help option, which gives a usage message.  */
938
  if (argmatch (argv, argc, "-help", "--help", 3, NULL, &skip_args))
Jim Blandy's avatar
Jim Blandy committed
939
    {
Kenichi Handa's avatar
Kenichi Handa committed
940 941
      printf (USAGE1, argv[0], USAGE2);
      printf (USAGE3);
942
      printf (USAGE4);
Karl Heuer's avatar
Karl Heuer committed
943
      exit (0);
Jim Blandy's avatar
Jim Blandy committed
944 945
    }

946 947
  if (argmatch (argv, argc, "-daemon", "--daemon", 5, NULL, &skip_args)
      || argmatch (argv, argc, "-daemon", "--daemon", 5, &dname_arg, &skip_args))
948
    {
949
#ifndef DOS_NT
950 951 952 953 954
      pid_t f;

      /* Start as a daemon: fork a new child process which will run the
	 rest of the initialization code, then exit.

955 956 957 958 959 960 961 962 963 964 965 966 967 968
	 Detaching a daemon requires the following steps:
	 - fork
	 - setsid
	 - exit the parent
	 - close the tty file-descriptors

	 We only want to do the last 2 steps once the daemon is ready to
	 serve requests, i.e. after loading .emacs (initialization).
	 OTOH initialization may start subprocesses (e.g. ispell) and these
	 should be run from the proper process (the one that will end up
	 running as daemon) and with the proper "session id" in order for
	 them to keep working after detaching, so fork and setsid need to be
	 performed before initialization.

969 970 971 972
	 We want to avoid exiting before the server socket is ready, so
	 use a pipe for synchronization.  The parent waits for the child
	 to close its end of the pipe (using `daemon-initialized')
	 before exiting.  */
973
      if (pipe2 (daemon_pipe, O_CLOEXEC) != 0)
974 975 976 977 978
	{
	  fprintf (stderr, "Cannot pipe!\n");
	  exit (1);
	}

979
#ifndef DAEMON_MUST_EXEC
980 981 982 983
#ifdef USE_GTK
      fprintf (stderr, "\nWarning: due to a long standing Gtk+ bug\nhttp://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
Emacs might crash when run in daemon mode and the X11 connection is unexpectedly lost.\n\
Using an Emacs configured with --with-x-toolkit=lucid does not have this problem.\n");
984
#endif /* USE_GTK */
985
      f = fork ();
986
#else /* DAEMON_MUST_EXEC */
987 988 989 990
      if (!dname_arg || !strchr (dname_arg, '\n'))
	  f = fork ();  /* in orig */
      else
	  f = 0;  /* in exec'd */
991
#endif /* !DAEMON_MUST_EXEC */
992
      if (f > 0)
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
	{
	  int retval;
	  char buf[1];

	  /* Close unused writing end of the pipe.  */
	  close (daemon_pipe[1]);

	  /* Just wait for the child to close its end of the pipe.  */
	  do
	    {
	      retval = read (daemon_pipe[0], &buf, 1);
	    }
	  while (retval == -1 && errno == EINTR);

	  if (retval < 0)
	    {
	      fprintf (stderr, "Error reading status from child\n");
	      exit (1);
	    }
1012 1013 1014 1015 1016
	  else if (retval == 0)
	    {
	      fprintf (stderr, "Error: server did not start correctly\n");
	      exit (1);
	    }
1017 1018 1019 1020

	  close (daemon_pipe[0]);
	  exit (0);
	}
1021 1022 1023
      if (f < 0)
	{
	  fprintf (stderr, "Cannot fork!\n");
1024
	  exit (1);
1025 1026
	}

1027
#ifdef DAEMON_MUST_EXEC
1028
      {
Adrian Robert's avatar
Adrian Robert committed
1029
        /* In orig process, forked as child, OR in exec'd. */
1030
        if (!dname_arg || !strchr (dname_arg, '\n'))
Adrian Robert's avatar
Adrian Robert committed
1031
          {  /* In orig, child: now exec w/special daemon name. */
1032
            char fdStr[80];
1033 1034 1035 1036
	    int fdStrlen =
	      snprintf (fdStr, sizeof fdStr,
			"--daemon=\n%d,%d\n%s", daemon_pipe[0],
			daemon_pipe[1], dname_arg ? dname_arg : "");
1037

1038
	    if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1039 1040 1041 1042 1043 1044 1045
              {
                fprintf (stderr, "daemon: child name too long\n");
                exit (1);
              }

            argv[skip_args] = fdStr;

1046
            execvp (argv[0], argv);
1047
            fprintf (stderr, "emacs daemon: exec failed: %d\n", errno);
1048 1049 1050
            exit (1);
          }

Adrian Robert's avatar
Adrian Robert committed
1051
        /* In exec'd: parse special dname into pipe and name info. */
1052 1053 1054 1055
        if (!dname_arg || !strchr (dname_arg, '\n')
            || strlen (dname_arg) < 1 || strlen (dname_arg) > 70)
          {
            fprintf (stderr, "emacs daemon: daemon name absent or too long\n");
Juanma Barranquero's avatar
Juanma Barranquero committed
1056
            exit (1);
1057 1058 1059 1060
          }
        dname_arg2[0] = '\0';
        sscanf (dname_arg, "\n%d,%d\n%s", &(daemon_pipe[0]), &(daemon_pipe[1]),
                dname_arg2);
1061
        dname_arg = *dname_arg2 ? dname_arg2 : NULL;
1062
      }
1063
#endif /* DAEMON_MUST_EXEC */
1064

1065 1066
      if (dname_arg)
       	daemon_name = xstrdup (dname_arg);
1067 1068
      /* Close unused reading end of the pipe.  */
      close (daemon_pipe[0]);
1069

Juanma Barranquero's avatar
Juanma Barranquero committed
1070
      setsid ();
1071
#else /* DOS_NT */
1072 1073
      fprintf (stderr, "This platform does not support the -daemon flag.\n");
      exit (1);
1074
#endif /* DOS_NT */
1075
    }
1076

1077
#if defined HAVE_PTHREAD && !defined SYSTEM_MALLOC && !defined DOUG_LEA_MALLOC
1078 1079 1080 1081 1082 1083 1084 1085
# ifndef CANNOT_DUMP
  /* Do not make gmalloc thread-safe when creating bootstrap-emacs, as
     that causes an infinite recursive loop with FreeBSD.  But do make
     it thread-safe when creating emacs, otherwise bootstrap-emacs
     fails on Cygwin.  See Bug#14569.  */
  if (!noninteractive || initialized)
# endif
    malloc_enable_thread ();
1086
#endif