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

3
Copyright (C) 1985-1987, 1993-1995, 1997-1999, 2001-2012
4
  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
#include <ignore-value.h>
32 33

#include "lisp.h"
34

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

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

46
#if defined HAVE_NTGUI && defined CYGWIN
Daniel Colascione's avatar
Daniel Colascione committed
47
#include "cygw32.h"
48 49
#endif

50 51 52 53
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

54 55 56 57 58
#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
59
#include "commands.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
60
#include "intervals.h"
61
#include "character.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
62
#include "buffer.h"
Stefan Monnier's avatar
Stefan Monnier committed
63
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
64

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

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

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

85 86 87 88
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif

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

94 95 96 97
#ifdef HAVE_PERSONALITY_LINUX32
#include <sys/personality.h>
#endif

98
static const char emacs_version[] = VERSION;
99
static const char emacs_copyright[] = COPYRIGHT;
100

101 102
/* 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
103

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

109 110 111 112
/* 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
113

114 115 116 117
#ifdef DARWIN_OS
extern void unexec_init_emacs_zone (void);
#endif

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

131 132
Lisp_Object Qfile_name_handler_alist;

Glenn Morris's avatar
Glenn Morris committed
133 134
Lisp_Object Qrisky_local_variable;

135 136
Lisp_Object Qkill_emacs;

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

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

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

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

154
#if defined (DOUG_LEA_MALLOC) || defined (GNU_LINUX)
155 156
/* The address where the heap starts (from the first sbrk (0) call).  */
static void *my_heap_start;
157
#endif
158

159
#ifdef GNU_LINUX
160
/* The gap between BSS end and heap start as far as we can tell.  */
161 162
static uprintmax_t heap_bss_diff;
#endif
163

164 165 166 167 168 169 170 171 172 173 174 175
/* 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. */
176
#if defined NS_IMPL_COCOA || (defined HAVE_NTGUI && defined CYGWIN)
177 178 179
# define DAEMON_MUST_EXEC
#endif

180 181
/* True means running Emacs without interactive terminal.  */
bool noninteractive;
Jim Blandy's avatar
Jim Blandy committed
182

183 184
/* True means remove site-lisp directories from load-path.  */
bool no_site_lisp;
185

186 187
/* Name for the server started by the daemon.*/
static char *daemon_name;
188

189 190
/* Pipe used to send exit notification to the daemon parent at
   startup.  */
191
int daemon_pipe[2];
192

193 194 195
/* Save argv and argc.  */
char **initial_argv;
int initial_argc;
196

197
static void sort_args (int argc, char **argv);
198
static void syms_of_emacs (void);
Gerd Moellmann's avatar
Gerd Moellmann committed
199

Kenichi Handa's avatar
Kenichi Handa committed
200 201
/* MSVC needs each string be shorter than 2048 bytes, so the usage
   strings below are split to not overflow this limit.  */
202
#define USAGE1 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
203 204 205 206 207 208
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\
209
Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
210 211 212 213
read the main documentation for these command-line arguments.\n\
\n\
Initialization options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
214
--batch                     do not do interactive display; implies -q\n\
215
--chdir DIR                 change to directory DIR\n\
Glenn Morris's avatar
Glenn Morris committed
216
--daemon                    start a server in the background\n\
Kenichi Handa's avatar
Kenichi Handa committed
217 218 219 220 221 222
--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\
223
--no-site-lisp, -nsl        do not add site-lisp directories to load-path\n\
Kenichi Handa's avatar
Kenichi Handa committed
224
--no-splash                 do not display a splash screen on startup\n\
225
--no-window-system, -nw     do not communicate with X, ignoring $DISPLAY\n\
226 227
--quick, -Q                 equivalent to:\n\
                              -q --no-site-file --no-site-lisp --no-splash\n\
Kenichi Handa's avatar
Kenichi Handa committed
228 229 230 231 232 233
--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
234 235
Action options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
236
FILE                    visit FILE using find-file\n\
237 238
+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
239 240 241 242 243 244 245 246 247 248
--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\
249 250
\n"

Kenichi Handa's avatar
Kenichi Handa committed
251
#define USAGE3 "\
252
Display options:\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
253
\n\
Kenichi Handa's avatar
Kenichi Handa committed
254
--background-color, -bg COLOR   window background color\n\
255 256
--basic-display, -D             disable many display features;\n\
                                  used for debugging Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
257 258
--border-color, -bd COLOR       main border color\n\
--border-width, -bw WIDTH       width of main border\n\
259
--color, --color=MODE           override color mode for character terminals;\n\
260 261
                                  MODE defaults to `auto', and\n\
                                  can also be `never', `always',\n\
Kenichi Handa's avatar
Kenichi Handa committed
262 263 264 265 266
                                  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\
267
--fullscreen, -fs               make the first frame fullscreen\n\
Kenichi Handa's avatar
Kenichi Handa committed
268
--fullwidth, -fw                make the first frame wide as the screen\n\
269
--maximized, -mm                make the first frame maximized\n\
Kenichi Handa's avatar
Kenichi Handa committed
270
--geometry, -g GEOMETRY         window geometry\n\
Jan Djärv's avatar
Jan Djärv committed
271
--no-bitmap-icon, -nbi          do not use picture of gnu for Emacs icon\n\
Kenichi Handa's avatar
Kenichi Handa committed
272 273 274 275 276
--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\
277
--no-blinking-cursor, -nbc      disable blinking cursor\n\
Kenichi Handa's avatar
Kenichi Handa committed
278 279 280 281
--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
282
--parent-id XID                 set parent window\n\
Kenichi Handa's avatar
Kenichi Handa committed
283 284
--help                          display this help and exit\n\
--version                       output version information and exit\n\
285 286 287
\n"

#define USAGE4 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
288 289 290 291 292 293
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\
294
\n\
295
Report bugs to bug-gnu-emacs@gnu.org.  First, please see the Bugs\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
296 297
section of the Emacs manual or the file BUGS.\n"

Jim Blandy's avatar
Jim Blandy committed
298

299 300
/* True if handling a fatal error already.  */
bool fatal_error_in_progress;
301

302 303 304
#ifdef HAVE_NS
/* NS autrelease pool, for memory management.  */
static void *ns_pool;
305 306
#endif

307

308

309 310 311
/* Report a fatal error due to signal SIG, output a backtrace of at
   most BACKTRACE_LIMIT lines, and exit.  */
_Noreturn void
312
terminate_due_to_signal (int sig, int backtrace_limit)
Jim Blandy's avatar
Jim Blandy committed
313 314
{
  signal (sig, SIG_DFL);
315
  totally_unblock_input ();
316

Jim Blandy's avatar
Jim Blandy committed
317
  /* If fatal error occurs in code below, avoid infinite recursion.  */
318 319 320
  if (! fatal_error_in_progress)
    {
      fatal_error_in_progress = 1;
Jim Blandy's avatar
Jim Blandy committed
321

322
      if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
323 324
        Fkill_emacs (make_number (sig));

325
      shut_down_emacs (sig, Qnil);
326
      emacs_backtrace (backtrace_limit);
327
    }
Jim Blandy's avatar
Jim Blandy committed
328

329
  /* Signal the same code; this time it will really be fatal.
330 331
     Since we're in a signal handler, the signal is blocked, so we
     have to unblock it if we want to really receive it.  */
332
#ifndef MSDOS
Paul Eggert's avatar
Paul Eggert committed
333 334 335
  {
    sigset_t unblocked;
    sigemptyset (&unblocked);
336
    sigaddset (&unblocked, sig);
Paul Eggert's avatar
Paul Eggert committed
337 338
    pthread_sigmask (SIG_UNBLOCK, &unblocked, 0);
  }
339
#endif
340

341
  emacs_raise (sig);
342 343 344

  /* This shouldn't be executed, but it prevents a warning.  */
  exit (1);
Jim Blandy's avatar
Jim Blandy committed
345
}
346 347 348

#ifdef SIGDANGER

Richard M. Stallman's avatar
Richard M. Stallman committed
349
/* Handler for SIGDANGER.  */
350 351
static void
handle_danger_signal (int sig)
352 353
{
  malloc_warning ("Operating system warns that virtual memory is running low.\n");
354 355 356

  /* It might be unsafe to call do_auto_save now.  */
  force_auto_save_soon ();
357
}
Richard M. Stallman's avatar
Richard M. Stallman committed
358

359 360
static void
deliver_danger_signal (int sig)
Richard M. Stallman's avatar
Richard M. Stallman committed
361
{
362
  deliver_process_signal (sig, handle_danger_signal);
Richard M. Stallman's avatar
Richard M. Stallman committed
363
}
364
#endif
Jim Blandy's avatar
Jim Blandy committed
365

Pavel Janík's avatar
Pavel Janík committed
366
/* Code for dealing with Lisp access to the Unix command line.  */
Jim Blandy's avatar
Jim Blandy committed
367

Andreas Schwab's avatar
Andreas Schwab committed
368
static void
369
init_cmdargs (int argc, char **argv, int skip_args)
Jim Blandy's avatar
Jim Blandy committed
370 371
{
  register int i;
372
  Lisp_Object name, dir, handler;
373
  ptrdiff_t count = SPECPDL_INDEX ();
374
  Lisp_Object raw_name;
Jim Blandy's avatar
Jim Blandy committed
375

376 377 378
  initial_argv = argv;
  initial_argc = argc;

379 380 381 382
  raw_name = build_string (argv[0]);

  /* Add /: to the front of the name
     if it would otherwise be treated as magic.  */
383 384
  handler = Ffind_file_name_handler (raw_name, Qt);
  if (! NILP (handler))
385 386 387 388 389
    raw_name = concat2 (build_string ("/:"), raw_name);

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

390 391 392 393 394 395
  /* 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,
396
		       Vexec_suffixes, &found, make_number (X_OK));
397
      if (yes == 1)
398 399 400
	{
	  /* Add /: to the front of the name
	     if it would otherwise be treated as magic.  */
401 402
	  handler = Ffind_file_name_handler (found, Qt);
	  if (! NILP (handler))
403 404 405
	    found = concat2 (build_string ("/:"), found);
	  Vinvocation_directory = Ffile_name_directory (found);
	}
406
    }
407

408 409
  if (!NILP (Vinvocation_directory)
      && NILP (Ffile_name_absolute_p (Vinvocation_directory)))
410 411
    /* Emacs was started with relative path, like ./emacs.
       Make it absolute.  */
412 413
    Vinvocation_directory = Fexpand_file_name (Vinvocation_directory, Qnil);

414 415 416 417 418
  Vinstallation_directory = Qnil;

  if (!NILP (Vinvocation_directory))
    {
      dir = Vinvocation_directory;
419 420 421 422 423 424 425 426 427 428
#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
429 430 431
      name = Fexpand_file_name (Vinvocation_name, dir);
      while (1)
	{
432
	  Lisp_Object tem, lib_src_exists;
433 434
	  Lisp_Object etc_exists, info_exists;

435 436 437 438 439
	  /* 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);
440

441
#ifdef MSDOS
442 443 444 445 446
	  /* 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);
447 448 449
#else
	  info_exists = Qnil;
#endif
450 451

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
452
	    {
453 454 455
	      tem = Fexpand_file_name (build_string ("etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
456
		{
457 458 459
		  Vinstallation_directory
		    = Ffile_name_as_directory (dir);
		  break;
460 461 462 463
		}
	    }

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

467 468 469

#ifdef MSDOS
	  /* See the MSDOS commentary above.  */
470 471
	  tem = Fexpand_file_name (build_string ("../info"), dir);
	  info_exists = Ffile_exists_p (tem);
472 473 474
#else
	  info_exists = Qnil;
#endif
475 476

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
477
	    {
478 479 480
	      tem = Fexpand_file_name (build_string ("../etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
481
		{
482 483 484 485
		  tem = Fexpand_file_name (build_string (".."), dir);
		  Vinstallation_directory
		    = Ffile_name_as_directory (tem);
		  break;
486 487 488 489 490 491 492 493
		}
	    }

	  /* 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))
	    {
494
	      name = Fexpand_file_name (tem, dir);
495 496 497 498 499 500 501
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
502 503 504 505 506
  Vcommand_line_args = Qnil;

  for (i = argc - 1; i >= 0; i--)
    {
      if (i == 0 || i > skip_args)
507 508 509
	/* 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
510
	Vcommand_line_args
511
	  = Fcons (make_unibyte_string (argv[i], strlen (argv[i])),
512
		   Vcommand_line_args);
Jim Blandy's avatar
Jim Blandy committed
513
    }
514 515

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
516
}
517 518

DEFUN ("invocation-name", Finvocation_name, Sinvocation_name, 0, 0, 0,
Pavel Janík's avatar
Pavel Janík committed
519 520
       doc: /* Return the program name that was used to run Emacs.
Any directory names are omitted.  */)
521
  (void)
522 523 524 525
{
  return Fcopy_sequence (Vinvocation_name);
}

526
DEFUN ("invocation-directory", Finvocation_directory, Sinvocation_directory,
Pavel Janík's avatar
Pavel Janík committed
527 528
       0, 0, 0,
       doc: /* Return the directory name in which the Emacs executable was located.  */)
529
  (void)
530 531 532 533
{
  return Fcopy_sequence (Vinvocation_directory);
}

Jim Blandy's avatar
Jim Blandy committed
534

535 536 537 538 539 540
#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.  */
static char dump_tz[] = "UtC0";
#endif

541
#ifndef ORDINARY_LINK
542 543 544 545 546
/* We don't include crtbegin.o and crtend.o in the link,
   so these functions and variables might be missed.
   Provide dummy definitions to avoid error.
   (We don't have any real constructors or destructors.)  */
#ifdef __GNUC__
547 548 549

/* Define a dummy function F.  Declare F too, to pacify gcc
   -Wmissing-prototypes.  */
550
#define DEFINE_DUMMY_FUNCTION(f) \
551
  void f (void) ATTRIBUTE_CONST EXTERNALLY_VISIBLE; void f (void) {}
552

553
#ifndef GCC_CTORS_IN_LIBC
554 555 556
DEFINE_DUMMY_FUNCTION (__do_global_ctors)
DEFINE_DUMMY_FUNCTION (__do_global_ctors_aux)
DEFINE_DUMMY_FUNCTION (__do_global_dtors)
Richard M. Stallman's avatar
Richard M. Stallman committed
557
/* GNU/Linux has a bug in its library; avoid an error.  */
558
#ifndef GNU_LINUX
559
char * __CTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
560
#endif
561
char * __DTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
562
#endif /* GCC_CTORS_IN_LIBC */
563
DEFINE_DUMMY_FUNCTION (__main)
564
#endif /* __GNUC__ */
565
#endif /* ORDINARY_LINK */
566

Karl Heuer's avatar
Karl Heuer committed
567 568 569 570 571 572 573 574 575
/* 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.  */
576

577
static bool
578 579
argmatch (char **argv, int argc, const char *sstr, const char *lstr,
          int minlen, char **valptr, int *skipptr)
Karl Heuer's avatar
Karl Heuer committed
580
{
581
  char *p = NULL;
582
  ptrdiff_t arglen;
583 584 585 586 587 588 589
  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
590 591 592 593 594 595 596 597 598 599 600 601 602
  if (arg == NULL)
    return 0;
  if (strcmp (arg, sstr) == 0)
    {
      if (valptr != NULL)
	{
	  *valptr = argv[*skipptr+2];
	  *skipptr += 2;
	}
      else
	*skipptr += 1;
      return 1;
    }
603
  arglen = (valptr != NULL && (p = strchr (arg, '=')) != NULL
Karl Heuer's avatar
Karl Heuer committed
604
	    ? p - arg : strlen (arg));
605
  if (lstr == 0 || arglen < minlen || strncmp (arg, lstr, arglen) != 0)
Karl Heuer's avatar
Karl Heuer committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
    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;
    }
}

630
#ifdef DOUG_LEA_MALLOC
Jim Blandy's avatar
Jim Blandy committed
631

632 633 634 635 636
/* 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
637
malloc_initialize_hook (void)
638
{
639 640
  if (initialized)
    {
641 642 643
      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
644 645 646 647
	   malloc checking.  Can't use unsetenv, since that calls malloc.  */
	{
	  char **p;

648
	  for (p = environ; p && *p; p++)
649 650 651 652 653 654 655 656
	    if (strncmp (*p, "MALLOC_CHECK_=", 14) == 0)
	      {
		do
		  *p = p[1];
		while (*++p);
		break;
	      }
	}
657

658
      malloc_set_state (malloc_state_ptr);
659
#ifndef XMALLOC_OVERRUN_CHECK
660
      free (malloc_state_ptr);
661
#endif
662
    }
663
  else
664 665 666 667 668
    {
      if (my_heap_start == 0)
        my_heap_start = sbrk (0);
      malloc_using_checking = getenv ("MALLOC_CHECK_") != NULL;
    }
669 670
}

671
void (*__malloc_initialize_hook) (void) EXTERNALLY_VISIBLE = malloc_initialize_hook;
672 673 674

#endif /* DOUG_LEA_MALLOC */

Paul Eggert's avatar
Paul Eggert committed
675 676 677 678 679 680 681 682
/* 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
683
	       strerror (errno));
Paul Eggert's avatar
Paul Eggert committed
684 685 686 687 688 689 690
      fflush (stderr);
      _exit (EXIT_FAILURE);
    }

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

692 693
/* ARGSUSED */
int
Dan Nicolaescu's avatar
Dan Nicolaescu committed
694
main (int argc, char **argv)
695
{
696
#if GC_MARK_STACK
697 698
  Lisp_Object dummy;
#endif
699
  char stack_bottom_variable;
700
  bool do_initial_setlocale;
701
  bool dumping;
702 703 704 705
  int skip_args = 0;
#ifdef HAVE_SETRLIMIT
  struct rlimit rlim;
#endif
706
  bool no_loadup = 0;
707
  char *junk = 0;
708
  char *dname_arg = 0;
709
#ifdef DAEMON_MUST_EXEC
710
  char dname_arg2[80];
711
#endif
712
  char *ch_to_dir;
713

714
#if GC_MARK_STACK
715 716 717
  stack_base = &dummy;
#endif

Ken Brown's avatar
Ken Brown committed
718
#ifdef G_SLICE_ALWAYS_MALLOC
719 720 721 722
  /* This is used by the Cygwin build.  */
  setenv ("G_SLICE", "always-malloc", 1);
#endif

723
#ifdef GNU_LINUX
724 725 726 727 728 729 730 731 732 733
  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);
    }
734
#endif
735

736 737 738 739 740
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

741 742
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
#ifdef DARWIN_OS
743 744 745 746
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

Paul Eggert's avatar
Paul Eggert committed
747 748
  atexit (close_output_streams);

749
  sort_args (argc, argv);
750 751
  argc = 0;
  while (argv[argc]) argc++;
752

753
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
754
    {
755 756
      const char *version, *copyright;
      if (initialized)
757
	{
758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
	  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
	    {
773 774
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
775
	    }
776
	}
777 778
      else
	{
779 780
	  version = emacs_version;
	  copyright = emacs_copyright;
781
	}
782 783 784 785 786 787 788 789
      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);
790
    }
791 792 793 794 795 796 797 798

  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);
      }
799

800 801
  dumping = !initialized && (strcmp (argv[argc - 1], "dump") == 0
			     || strcmp (argv[argc - 1], "bootstrap") == 0);
802

803
#ifdef HAVE_PERSONALITY_LINUX32
804
  if (dumping && ! getenv ("EMACS_HEAP_EXEC"))
805
    {
806
      static char heapexec[] = "EMACS_HEAP_EXEC=true";
807
      /* Set this so we only do this once.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
808
      putenv (heapexec);
809

810 811
      /* A flag to turn off address randomization which is introduced
         in linux kernel shipped with fedora core 4 */
812
#define ADD_NO_RANDOMIZE 0x0040000
813
      personality (PER_LINUX32 | ADD_NO_RANDOMIZE);
814 815
#undef  ADD_NO_RANDOMIZE

816
      execvp (argv[0], argv);
817

818 819
      /* If the exec fails, try to dump anyway.  */
      perror ("execvp");
820 821 822
    }
#endif /* HAVE_PERSONALITY_LINUX32 */

823
#if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK)
824 825 826 827 828 829 830 831
  /* 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))
832
    {
833
      long newlim;
834
      extern size_t re_max_failures;
835 836 837 838 839 840 841 842
      /* 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;
843 844 845 846 847
#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
848
      newlim = (newlim + getpagesize () - 1) / getpagesize () * getpagesize ();
849
#endif
850
      if (newlim > rlim.rlim_max)
851 852
	{
	  newlim = rlim.rlim_max;
853 854
	  /* Don't let regex.c overflow the stack we have.  */
	  re_max_failures = (newlim - 200000) / ratio;
855
	}
856 857 858
      if (rlim.rlim_cur < newlim)
	rlim.rlim_cur = newlim;

859 860
      setrlimit (RLIMIT_STACK, &rlim);
    }
861
#endif /* HAVE_SETRLIMIT and RLIMIT_STACK */
862

Jim Blandy's avatar
Jim Blandy committed
863 864 865 866
  /* Record (approximately) where the stack begins.  */
  stack_bottom = &stack_bottom_variable;

  clearerr (stdin);
867

Jim Blandy's avatar
Jim Blandy committed
868
#ifndef SYSTEM_MALLOC
869 870
  /* Arrange to get warning messages as memory fills up.  */
  memory_warnings (0, malloc_warning);
871

872
  /* Call malloc at least once, to run malloc_initialize_hook.
873 874
     Also call realloc and free for consistency.  */
  free (realloc (malloc (4), 4));
875

Jim Blandy's avatar
Jim Blandy committed
876 877
#endif	/* not SYSTEM_MALLOC */

878
#if defined (MSDOS) || defined (WINDOWSNT)
879 880 881
  /* We do all file input/output as binary files.  When we need to translate
     newlines, we do that manually.  */
  _fmode = O_BINARY;
882
#endif /* MSDOS || WINDOWSNT */
883

884
#ifdef MSDOS
885 886 887 888 889 890 891
  if (!isatty (fileno (stdin)))
    setmode (fileno (stdin), O_BINARY);
  if (!isatty (fileno (stdout)))
    {
      fflush (stdout);
      setmode (fileno (stdout), O_BINARY);
    }
892 893
#endif /* MSDOS */

894 895 896 897 898 899 900 901 902 903 904 905 906 907
  /* 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
908 909
  inhibit_window_system = 0;

Pavel Janík's avatar
Pavel Janík committed
910
  /* Handle the -t switch, which specifies filename to use as terminal.  */
911 912 913 914 915 916
  while (1)
    {
      char *term;
      if (argmatch (argv, argc, "-t", "--terminal", 4, &term, &skip_args))
	{
	  int result;
917 918 919
	  emacs_close (0);
	  emacs_close (1);
	  result = emacs_open (term, O_RDWR, 0);
920
	  if (result < 0 || dup (0) < 0)
921 922
	    {
	      char *errstring = strerror (errno);
923
	      fprintf (stderr, "%s: %s: %s\n", argv[0], term, errstring);
924 925 926 927
	      exit (1);
	    }
	  if (! isatty (0))
	    {
928
	      fprintf (stderr, "%s: %s: not a tty\n", argv[0], term);
929 930 931
	      exit (1);
	    }
	  fprintf (stderr, "Using %s\n", term);
932
#ifdef HAVE_WINDOW_SYSTEM
933
	  inhibit_window_system = 1; /* -t => -nw */
Jim Blandy's avatar
Jim Blandy committed
934
#endif
935 936 937 938 939
	}
      else
	break;
    }

940
  /* Command line option --no-windows is deprecated and thus not mentioned
Paul Eggert's avatar
Paul Eggert committed
941
     in the manual and usage information.  */
942 943
  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
944
    inhibit_window_system = 1;
Jim Blandy's avatar
Jim Blandy committed
945

Karl Heuer's avatar
Karl Heuer committed
946
  /* Handle the -batch switch, which means don't do interactive display.  */
Jim Blandy's avatar
Jim Blandy committed
947
  noninteractive = 0;
948
  if (argmatch (argv, argc, "-batch", "--batch", 5, NULL, &skip_args))
949 950 951 952
    {
      noninteractive = 1;
      Vundo_outer_limit = Qnil;
    }
953 954 955
  if (argmatch (argv, argc, "-script", "--script", 3, &junk, &skip_args))
    {
      noninteractive = 1;	/* Set batch mode.  */
956
      /* Convert --script to -scriptload, un-skip it, and sort again
957
	 so that it will be handled in proper sequence.  */
958
      /* FIXME broken for --script=FILE - is that supposed to work?  */
959
      argv[skip_args - 1] = (char *) "-scriptload";
960 961 962
      skip_args -= 2;
      sort_args (argc, argv);
    }
Karl Heuer's avatar
Karl Heuer committed
963

Pavel Janík's avatar
Pavel Janík committed
964
  /* Handle the --help option, which gives a usage message.  */
965
  if (argmatch (argv, argc, "-help", "--help", 3, NULL, &skip_args))
Jim Blandy's avatar
Jim Blandy committed
966
    {
Kenichi Handa's avatar
Kenichi Handa committed
967 968
      printf (USAGE1, argv[0], USAGE2);
      printf (USAGE3);
969
      printf (USAGE4);
Karl Heuer's avatar
Karl Heuer committed
970
      exit (0);
Jim Blandy's avatar
Jim Blandy committed
971 972
    }

973 974
  if (argmatch (argv, argc, "-daemon", "--daemon", 5, NULL, &skip_args)
      || argmatch (argv, argc, "-daemon", "--daemon", 5, &dname_arg, &skip_args))
975
    {
976
#ifndef DOS_NT
977 978 979 980 981
      pid_t f;

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

982 983 984 985 986 987 988 989 990 991 992 993 994 995
	 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.

996 997 998 999 1000 1001 1002 1003 1004 1005
	 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.  */
      if (pipe (daemon_pipe) == -1)
	{
	  fprintf (stderr, "Cannot pipe!\n");
	  exit (1);
	}

1006
#ifndef DAEMON_MUST_EXEC
1007 1008 1009 1010
#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");
1011
#endif /* USE_GTK */
1012
      f = fork ();
1013
#else /* DAEMON_MUST_EXEC */
1014 1015 1016 1017
      if (!dname_arg || !strchr (dname_arg, '\n'))
	  f = fork ();  /* in orig */
      else
	  f = 0;  /* in exec'd */
1018
#endif /* !DAEMON_MUST_EXEC */
1019
      if (f > 0)
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038
	{
	  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);
	    }
1039 1040 1041 1042 1043
	  else if (retval == 0)
	    {
	      fprintf (stderr, "Error: server did not start correctly\n");
	      exit (1);
	    }
1044 1045 1046 1047

	  close (daemon_pipe[0]);
	  exit (0);
	}
1048 1049 1050
      if (f < 0)
	{
	  fprintf (stderr, "Cannot fork!\n");
1051
	  exit (1);
1052 1053
	}

1054
#ifdef DAEMON_MUST_EXEC
1055
      {
Adrian Robert's avatar
Adrian Robert committed
1056
        /* In orig process, forked as child, OR in exec'd. */
1057
        if (!dname_arg || !strchr (dname_arg, '\n'))
Adrian Robert's avatar
Adrian Robert committed
1058
          {  /* In orig, child: now exec w/special daemon name. */
1059
            char fdStr[80];
1060 1061 1062 1063
	    int fdStrlen =
	      snprintf (fdStr, sizeof fdStr,
			"--daemon=\n%d,%d\n%s", daemon_pipe[0],
			daemon_pipe[1], dname_arg ? dname_arg : "");
1064

1065
	    if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1066 1067 1068 1069 1070 1071 1072 1073
              {
                fprintf (stderr, "daemon: child name too long\n");
                exit (1);
              }

            argv[skip_args] = fdStr;

            execv (argv[0], argv);
1074
            fprintf (stderr, "emacs daemon: exec failed: %d\n", errno);
1075 1076 1077
            exit (1);
          }

Adrian Robert's avatar
Adrian Robert committed
1078
        /* In exec'd: parse special dname into pipe and name info. */
1079 1080 1081 1082
        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