emacs.c 73.6 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 28
#include <signal.h>
#include <errno.h>
#include <stdio.h>

#include <sys/types.h>
#include <sys/file.h>
29
#include <setjmp.h>
30 31
#include <unistd.h>

32 33
#include "lisp.h"

34 35 36 37
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

38 39
#ifdef WINDOWSNT
#include <fcntl.h>
40 41
#include <windows.h> /* just for w32.h */
#include "w32.h"
42
#include "w32heap.h" /* for prototype of sbrk */
43 44
#endif

45 46 47 48 49
#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
50
#include "commands.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51
#include "intervals.h"
52
#include "character.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
53
#include "buffer.h"
Stefan Monnier's avatar
Stefan Monnier committed
54
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
55

56
#include "systty.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
57
#include "blockinput.h"
58
#include "syssignal.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
59
#include "process.h"
60
#include "frame.h"
61
#include "termhooks.h"
Andreas Schwab's avatar
Andreas Schwab committed
62
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
63
#include "keymap.h"
Jim Blandy's avatar
Jim Blandy committed
64

Ted Zlatanov's avatar
Ted Zlatanov committed
65 66 67 68
#ifdef HAVE_GNUTLS
#include "gnutls.h"
#endif

69 70 71 72 73 74
#if (defined PROFILING \
     && (defined __FreeBSD__ || defined GNU_LINUX || defined __MINGW32__))
# include <sys/gmon.h>
extern void moncontrol (int mode);
#endif

75 76 77 78
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif

79 80 81 82 83
#ifdef HAVE_SETRLIMIT
#include <sys/time.h>
#include <sys/resource.h>
#endif

84 85 86 87
#ifdef HAVE_PERSONALITY_LINUX32
#include <sys/personality.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
88 89 90 91
#ifndef O_RDWR
#define O_RDWR 2
#endif

92
static const char emacs_version[] = VERSION;
93
static const char emacs_copyright[] = "Copyright (C) 2012 Free Software Foundation, Inc.";
94

95 96
/* 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
97

Jim Blandy's avatar
Jim Blandy committed
98 99 100 101 102
/* Set nonzero after Emacs has started up the first time.
  Prevents reinitialization of the Lisp world and keymaps
  on subsequent starts.  */
int initialized;

103 104 105 106
#ifdef DARWIN_OS
extern void unexec_init_emacs_zone (void);
#endif

107 108 109
#ifdef DOUG_LEA_MALLOC
/* Preserves a pointer to the memory allocated that copies that
   static data inside glibc's malloc.  */
110
static void *malloc_state_ptr;
111
/* From glibc, a routine that returns a copy of the malloc internal state.  */
112
extern void *malloc_get_state (void);
113
/* From glibc, a routine that overwrites the malloc internal state.  */
114
extern int malloc_set_state (void*);
115
/* Non-zero if the MALLOC_CHECK_ environment variable was set while
116
   dumping.  Used to work around a bug in glibc's malloc.  */
117
static int malloc_using_checking;
118 119
#endif

120 121
Lisp_Object Qfile_name_handler_alist;

Glenn Morris's avatar
Glenn Morris committed
122 123
Lisp_Object Qrisky_local_variable;

124 125
Lisp_Object Qkill_emacs;

126
/* If non-zero, Emacs should not attempt to use a window-specific code,
Pavel Janík's avatar
Pavel Janík committed
127
   but instead should use the virtual terminal under which it was started.  */
Jim Blandy's avatar
Jim Blandy committed
128 129
int inhibit_window_system;

Pavel Janík's avatar
Pavel Janík committed
130 131
/* If non-zero, a filter or a sentinel is running.  Tested to save the match
   data on the first attempt to change it inside asynchronous code.  */
132 133
int running_asynch_code;

Juanma Barranquero's avatar
Juanma Barranquero committed
134
#if defined (HAVE_X_WINDOWS) || defined (HAVE_NS)
Pavel Janík's avatar
Pavel Janík committed
135
/* If non-zero, -d was specified, meaning we're using some window system.  */
Jim Blandy's avatar
Jim Blandy committed
136 137 138 139 140 141 142
int display_arg;
#endif

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

143
#if defined (DOUG_LEA_MALLOC) || defined (GNU_LINUX)
144 145
/* The address where the heap starts (from the first sbrk (0) call).  */
static void *my_heap_start;
146
#endif
147

148
#ifdef GNU_LINUX
149
/* The gap between BSS end and heap start as far as we can tell.  */
150 151
static uprintmax_t heap_bss_diff;
#endif
152

Jim Blandy's avatar
Jim Blandy committed
153 154 155
/* Nonzero means running Emacs without interactive terminal.  */
int noninteractive;

156 157 158
/* Nonzero means remove site-lisp directories from load-path.  */
int no_site_lisp;

159 160
/* Name for the server started by the daemon.*/
static char *daemon_name;
161

162 163
/* Pipe used to send exit notification to the daemon parent at
   startup.  */
164
int daemon_pipe[2];
165

166 167 168
/* Save argv and argc.  */
char **initial_argv;
int initial_argc;
169

170
static void sort_args (int argc, char **argv);
171
static void syms_of_emacs (void);
Gerd Moellmann's avatar
Gerd Moellmann committed
172

Kenichi Handa's avatar
Kenichi Handa committed
173 174
/* MSVC needs each string be shorter than 2048 bytes, so the usage
   strings below are split to not overflow this limit.  */
175
#define USAGE1 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
176 177 178 179 180 181
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\
182
Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
183 184 185 186
read the main documentation for these command-line arguments.\n\
\n\
Initialization options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
187
--batch                     do not do interactive display; implies -q\n\
188
--chdir DIR                 change to directory DIR\n\
Glenn Morris's avatar
Glenn Morris committed
189
--daemon                    start a server in the background\n\
Kenichi Handa's avatar
Kenichi Handa committed
190 191 192 193 194 195
--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\
196
--no-site-lisp, -nsl        do not add site-lisp directories to load-path\n\
Kenichi Handa's avatar
Kenichi Handa committed
197
--no-splash                 do not display a splash screen on startup\n\
198
--no-window-system, -nw     do not communicate with X, ignoring $DISPLAY\n\
199 200
--quick, -Q                 equivalent to:\n\
                              -q --no-site-file --no-site-lisp --no-splash\n\
Kenichi Handa's avatar
Kenichi Handa committed
201 202 203 204 205 206
--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
207 208
Action options:\n\
\n\
Kenichi Handa's avatar
Kenichi Handa committed
209
FILE                    visit FILE using find-file\n\
210 211
+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
212 213 214 215 216 217 218 219 220 221
--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\
222 223
\n"

Kenichi Handa's avatar
Kenichi Handa committed
224
#define USAGE3 "\
225
Display options:\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
226
\n\
Kenichi Handa's avatar
Kenichi Handa committed
227
--background-color, -bg COLOR   window background color\n\
228 229
--basic-display, -D             disable many display features;\n\
                                  used for debugging Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
230 231
--border-color, -bd COLOR       main border color\n\
--border-width, -bw WIDTH       width of main border\n\
232
--color, --color=MODE           override color mode for character terminals;\n\
233 234
                                  MODE defaults to `auto', and\n\
                                  can also be `never', `always',\n\
Kenichi Handa's avatar
Kenichi Handa committed
235 236 237 238 239
                                  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\
240
--fullscreen, -fs               make the first frame fullscreen\n\
Kenichi Handa's avatar
Kenichi Handa committed
241
--fullwidth, -fw                make the first frame wide as the screen\n\
242
--maximized, -mm                make the first frame maximized\n\
Kenichi Handa's avatar
Kenichi Handa committed
243
--geometry, -g GEOMETRY         window geometry\n\
Jan Djärv's avatar
Jan Djärv committed
244
--no-bitmap-icon, -nbi          do not use picture of gnu for Emacs icon\n\
Kenichi Handa's avatar
Kenichi Handa committed
245 246 247 248 249
--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\
250
--no-blinking-cursor, -nbc      disable blinking cursor\n\
Kenichi Handa's avatar
Kenichi Handa committed
251 252 253 254
--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
255
--parent-id XID                 set parent window\n\
Kenichi Handa's avatar
Kenichi Handa committed
256 257
--help                          display this help and exit\n\
--version                       output version information and exit\n\
258 259 260
\n"

#define USAGE4 "\
Gerd Moellmann's avatar
Gerd Moellmann committed
261 262 263 264 265 266
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\
267
\n\
268
Report bugs to bug-gnu-emacs@gnu.org.  First, please see the Bugs\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
269 270
section of the Emacs manual or the file BUGS.\n"

Jim Blandy's avatar
Jim Blandy committed
271

Pavel Janík's avatar
Pavel Janík committed
272
/* Signal code for the fatal signal that was received.  */
273
static int fatal_error_code;
Jim Blandy's avatar
Jim Blandy committed
274

Pavel Janík's avatar
Pavel Janík committed
275
/* Nonzero if handling a fatal error already.  */
Jim Blandy's avatar
Jim Blandy committed
276 277
int fatal_error_in_progress;

278
#ifdef FORWARD_SIGNAL_TO_MAIN_THREAD
279 280
/* When compiled with GTK and running under Gnome,
   multiple threads may be created.  Keep track of our main
281
   thread to make sure signals are delivered to it (see syssignal.h).  */
282 283 284 285

pthread_t main_thread;
#endif

286 287 288
#ifdef HAVE_NS
/* NS autrelease pool, for memory management.  */
static void *ns_pool;
289 290
#endif

291

292

Pavel Janík's avatar
Pavel Janík committed
293
/* Handle bus errors, invalid instruction, etc.  */
294 295 296
#ifndef FLOAT_CATCH_SIGILL
static
#endif
297
void
298
fatal_error_signal (int sig)
Jim Blandy's avatar
Jim Blandy committed
299
{
300
  SIGNAL_THREAD_CHECK (sig);
Jim Blandy's avatar
Jim Blandy committed
301 302 303
  fatal_error_code = sig;
  signal (sig, SIG_DFL);

304 305
  TOTALLY_UNBLOCK_INPUT;

Jim Blandy's avatar
Jim Blandy committed
306
  /* If fatal error occurs in code below, avoid infinite recursion.  */
307 308 309
  if (! fatal_error_in_progress)
    {
      fatal_error_in_progress = 1;
Jim Blandy's avatar
Jim Blandy committed
310

311
      if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
312 313
        Fkill_emacs (make_number (sig));

314
      shut_down_emacs (sig, 0, Qnil);
315
    }
Jim Blandy's avatar
Jim Blandy committed
316

317 318 319 320
  /* Signal the same code; this time it will really be fatal.
     Remember that since we're in a signal handler, the signal we're
     going to send is probably blocked, so we have to unblock it if we
     want to really receive it.  */
321
#ifndef MSDOS
322
  sigunblock (sigmask (fatal_error_code));
323
#endif
324

Jim Blandy's avatar
Jim Blandy committed
325 326
  kill (getpid (), fatal_error_code);
}
327 328 329

#ifdef SIGDANGER

Richard M. Stallman's avatar
Richard M. Stallman committed
330
/* Handler for SIGDANGER.  */
331
void
Andreas Schwab's avatar
Andreas Schwab committed
332
memory_warning_signal (int sig)
333 334
{
  signal (sig, memory_warning_signal);
335
  SIGNAL_THREAD_CHECK (sig);
336 337

  malloc_warning ("Operating system warns that virtual memory is running low.\n");
338 339 340

  /* It might be unsafe to call do_auto_save now.  */
  force_auto_save_soon ();
341 342
}
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
343 344

/* We define abort, rather than using it from the library,
Karl Heuer's avatar
Karl Heuer committed
345
   so that GDB can return from a breakpoint here.
Pavel Janík's avatar
Pavel Janík committed
346
   MSDOS has its own definition in msdos.c.  */
Richard M. Stallman's avatar
Richard M. Stallman committed
347

348
#if ! defined (DOS_NT) && ! defined (NO_ABORT)
349

350
void
Andreas Schwab's avatar
Andreas Schwab committed
351
abort (void)
Richard M. Stallman's avatar
Richard M. Stallman committed
352 353
{
  kill (getpid (), SIGABRT);
354 355
  /* This shouldn't be executed, but it prevents a warning.  */
  exit (1);
Richard M. Stallman's avatar
Richard M. Stallman committed
356
}
Karl Heuer's avatar
Karl Heuer committed
357
#endif
Richard M. Stallman's avatar
Richard M. Stallman committed
358

Jim Blandy's avatar
Jim Blandy committed
359

Pavel Janík's avatar
Pavel Janík committed
360
/* Code for dealing with Lisp access to the Unix command line.  */
Jim Blandy's avatar
Jim Blandy committed
361

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

370 371 372
  initial_argv = argv;
  initial_argc = argc;

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

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

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

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

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

408 409 410 411 412
  Vinstallation_directory = Qnil;

  if (!NILP (Vinvocation_directory))
    {
      dir = Vinvocation_directory;
413 414 415 416 417 418 419 420 421 422
#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
423 424 425
      name = Fexpand_file_name (Vinvocation_name, dir);
      while (1)
	{
426
	  Lisp_Object tem, lib_src_exists;
427 428
	  Lisp_Object etc_exists, info_exists;

429 430 431 432 433
	  /* 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);
434

435
#ifdef MSDOS
436 437 438 439 440
	  /* 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);
441 442 443
#else
	  info_exists = Qnil;
#endif
444 445

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

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

461 462 463

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

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

	  /* 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))
	    {
488
	      name = Fexpand_file_name (tem, dir);
489 490 491 492 493 494 495
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

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

  for (i = argc - 1; i >= 0; i--)
    {
      if (i == 0 || i > skip_args)
501 502 503
	/* 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
504
	Vcommand_line_args
505
	  = Fcons (make_unibyte_string (argv[i], strlen (argv[i])),
506
		   Vcommand_line_args);
Jim Blandy's avatar
Jim Blandy committed
507
    }
508 509

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

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

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

Jim Blandy's avatar
Jim Blandy committed
528

529 530 531 532 533 534
#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

535
#ifndef ORDINARY_LINK
536 537 538 539 540
/* 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__
541 542 543

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

547
#ifndef GCC_CTORS_IN_LIBC
548 549 550
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
551
/* GNU/Linux has a bug in its library; avoid an error.  */
552
#ifndef GNU_LINUX
553
char * __CTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
554
#endif
555
char * __DTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
556
#endif /* GCC_CTORS_IN_LIBC */
557
DEFINE_DUMMY_FUNCTION (__main)
558
#endif /* __GNUC__ */
559
#endif /* ORDINARY_LINK */
560

Karl Heuer's avatar
Karl Heuer committed
561 562 563 564 565 566 567 568 569
/* 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.  */
570

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

624
#ifdef DOUG_LEA_MALLOC
Jim Blandy's avatar
Jim Blandy committed
625

626 627 628 629 630
/* 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
631
malloc_initialize_hook (void)
632
{
633 634
  if (initialized)
    {
635 636 637
      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
638 639 640 641
	   malloc checking.  Can't use unsetenv, since that calls malloc.  */
	{
	  char **p;

642
	  for (p = environ; p && *p; p++)
643 644 645 646 647 648 649 650
	    if (strncmp (*p, "MALLOC_CHECK_=", 14) == 0)
	      {
		do
		  *p = p[1];
		while (*++p);
		break;
	      }
	}
651

652
      malloc_set_state (malloc_state_ptr);
653
#ifndef XMALLOC_OVERRUN_CHECK
654
      free (malloc_state_ptr);
655
#endif
656
    }
657
  else
658 659 660 661 662
    {
      if (my_heap_start == 0)
        my_heap_start = sbrk (0);
      malloc_using_checking = getenv ("MALLOC_CHECK_") != NULL;
    }
663 664
}

665
void (*__malloc_initialize_hook) (void) EXTERNALLY_VISIBLE = malloc_initialize_hook;
666 667 668

#endif /* DOUG_LEA_MALLOC */

669

670 671
/* ARGSUSED */
int
Dan Nicolaescu's avatar
Dan Nicolaescu committed
672
main (int argc, char **argv)
673
{
674
#if GC_MARK_STACK
675 676
  Lisp_Object dummy;
#endif
677
  char stack_bottom_variable;
678
  int do_initial_setlocale;
679 680 681 682 683
  int skip_args = 0;
#ifdef HAVE_SETRLIMIT
  struct rlimit rlim;
#endif
  int no_loadup = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
684
  char *junk = 0;
685
  char *dname_arg = 0;
686 687 688
#ifdef NS_IMPL_COCOA
  char dname_arg2[80];
#endif
689
  char *ch_to_dir;
690

691
#if GC_MARK_STACK
692 693 694
  stack_base = &dummy;
#endif

695 696 697 698 699
#if defined (USE_GTK) && defined (G_SLICE_ALWAYS_MALLOC)
  /* This is used by the Cygwin build.  */
  setenv ("G_SLICE", "always-malloc", 1);
#endif

700
#ifdef GNU_LINUX
701 702 703 704 705 706 707 708 709 710
  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);
    }
711
#endif
712

713 714 715 716 717
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

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

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

728
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
729
    {
730 731
      const char *version, *copyright;
      if (initialized)
732
	{
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
	  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
	    {
748 749
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
750
	    }
751
	}
752 753
      else
	{
754 755
	  version = emacs_version;
	  copyright = emacs_copyright;
756
	}
757 758 759 760 761 762 763 764
      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);
765
    }
766 767 768 769 770 771 772 773

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

775

776 777 778 779
#ifdef HAVE_PERSONALITY_LINUX32
  if (!initialized
      && (strcmp (argv[argc-1], "dump") == 0
          || strcmp (argv[argc-1], "bootstrap") == 0)
780
      && ! getenv ("EMACS_HEAP_EXEC"))
781
    {
782
      static char heapexec[] = "EMACS_HEAP_EXEC=true";
783
      /* Set this so we only do this once.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
784
      putenv (heapexec);
785

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

792
      execvp (argv[0], argv);
793

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

799
#if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK)
800 801 802 803 804 805 806 807
  /* 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))
808
    {
809
      long newlim;
810
      extern size_t re_max_failures;
811 812 813 814 815 816 817 818
      /* 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;
819 820 821 822 823
#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
824
      newlim = (newlim + getpagesize () - 1) / getpagesize () * getpagesize ();
825
#endif
826
      if (newlim > rlim.rlim_max)
827 828
	{
	  newlim = rlim.rlim_max;
829 830
	  /* Don't let regex.c overflow the stack we have.  */
	  re_max_failures = (newlim - 200000) / ratio;
831
	}
832 833 834
      if (rlim.rlim_cur < newlim)
	rlim.rlim_cur = newlim;

835 836
      setrlimit (RLIMIT_STACK, &rlim);
    }
837
#endif /* HAVE_SETRLIMIT and RLIMIT_STACK */
838

Jim Blandy's avatar
Jim Blandy committed
839 840 841 842
  /* Record (approximately) where the stack begins.  */
  stack_bottom = &stack_bottom_variable;

  clearerr (stdin);
843

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

848 849 850
  /* Call malloc at least once, to run the initial __malloc_hook.
     Also call realloc and free for consistency.  */
  free (realloc (malloc (4), 4));
851

852
# ifndef SYNC_INPUT
853 854
  /* Arrange to disable interrupt input inside malloc etc.  */
  uninterrupt_malloc ();
855
# endif /* not SYNC_INPUT */
Jim Blandy's avatar
Jim Blandy committed
856 857
#endif	/* not SYSTEM_MALLOC */

858
#ifdef FORWARD_SIGNAL_TO_MAIN_THREAD
859
  main_thread = pthread_self ();
860
#endif /* FORWARD_SIGNAL_TO_MAIN_THREAD */
861

862
#if defined (MSDOS) || defined (WINDOWSNT)
863 864 865
  /* We do all file input/output as binary files.  When we need to translate
     newlines, we do that manually.  */
  _fmode = O_BINARY;
866
#endif /* MSDOS || WINDOWSNT */
867

868
#ifdef MSDOS
869 870 871 872 873 874 875
  if (!isatty (fileno (stdin)))
    setmode (fileno (stdin), O_BINARY);
  if (!isatty (fileno (stdout)))
    {
      fflush (stdout);
      setmode (fileno (stdout), O_BINARY);
    }
876 877
#endif /* MSDOS */

878 879 880 881 882 883 884 885 886 887 888 889 890 891
  /* 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
892 893
  inhibit_window_system = 0;

Pavel Janík's avatar
Pavel Janík committed
894
  /* Handle the -t switch, which specifies filename to use as terminal.  */
895 896 897 898 899 900
  while (1)
    {
      char *term;
      if (argmatch (argv, argc, "-t", "--terminal", 4, &term, &skip_args))
	{
	  int result;
901 902 903
	  emacs_close (0);
	  emacs_close (1);
	  result = emacs_open (term, O_RDWR, 0);
904
	  if (result < 0 || dup (0) < 0)
905 906
	    {
	      char *errstring = strerror (errno);
907
	      fprintf (stderr, "%s: %s: %s\n", argv[0], term, errstring);
908 909 910 911
	      exit (1);
	    }
	  if (! isatty (0))
	    {
912
	      fprintf (stderr, "%s: %s: not a tty\n", argv[0], term);
913 914 915
	      exit (1);
	    }
	  fprintf (stderr, "Using %s\n", term);
916
#ifdef HAVE_WINDOW_SYSTEM
917
	  inhibit_window_system = 1; /* -t => -nw */
Jim Blandy's avatar
Jim Blandy committed
918
#endif
919 920 921 922 923
	}
      else
	break;
    }

924
  /* Command line option --no-windows is deprecated and thus not mentioned
Paul Eggert's avatar
Paul Eggert committed
925
     in the manual and usage information.  */
926 927
  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
928
    inhibit_window_system = 1;
Jim Blandy's avatar
Jim Blandy committed
929

Karl Heuer's avatar
Karl Heuer committed
930
  /* Handle the -batch switch, which means don't do interactive display.  */
Jim Blandy's avatar
Jim Blandy committed
931
  noninteractive = 0;
932
  if (argmatch (argv, argc, "-batch", "--batch", 5, NULL, &skip_args))
933 934 935 936
    {
      noninteractive = 1;
      Vundo_outer_limit = Qnil;
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
937 938 939
  if (argmatch (argv, argc, "-script", "--script", 3, &junk, &skip_args))
    {
      noninteractive = 1;	/* Set batch mode.  */
Glenn Morris's avatar
Glenn Morris committed
940
      /* Convert --script to -scriptload, un-skip it, and sort again
941
	 so that it will be handled in proper sequence.  */
942
      /* FIXME broken for --script=FILE - is that supposed to work?  */
943
      argv[skip_args - 1] = (char *) "-scriptload";
Richard M. Stallman's avatar
Richard M. Stallman committed
944 945 946
      skip_args -= 2;
      sort_args (argc, argv);
    }
Karl Heuer's avatar
Karl Heuer committed
947

Pavel Janík's avatar
Pavel Janík committed
948
  /* Handle the --help option, which gives a usage message.  */
949
  if (argmatch (argv, argc, "-help", "--help", 3, NULL, &skip_args))
Jim Blandy's avatar
Jim Blandy committed
950
    {
Kenichi Handa's avatar
Kenichi Handa committed
951 952
      printf (USAGE1, argv[0], USAGE2);
      printf (USAGE3);
953
      printf (USAGE4);
Karl Heuer's avatar
Karl Heuer committed
954
      exit (0);
Jim Blandy's avatar
Jim Blandy committed
955 956
    }

957 958
  if (argmatch (argv, argc, "-daemon", "--daemon", 5, NULL, &skip_args)
      || argmatch (argv, argc, "-daemon", "--daemon", 5, &dname_arg, &skip_args))
959
    {
960
#ifndef DOS_NT
961 962 963 964 965
      pid_t f;

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

966 967 968 969 970 971 972 973 974 975 976 977 978 979
	 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.

980 981 982 983 984 985 986 987 988 989
	 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);
	}

990
#ifndef NS_IMPL_COCOA
991 992 993 994 995
#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");
#endif
996
      f = fork ();
Adrian Robert's avatar
Adrian Robert committed
997 998 999 1000
#else /* NS_IMPL_COCOA */
      /* Under Cocoa we must do fork+exec as CoreFoundation lib fails in
         forked process: http://developer.apple.com/ReleaseNotes/
                                  CoreFoundation/CoreFoundation.html)
1001 1002 1003 1004 1005 1006 1007
         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. */
      if (!dname_arg || !strchr (dname_arg, '\n'))
	  f = fork ();  /* in orig */
      else
	  f = 0;  /* in exec'd */
Adrian Robert's avatar
Adrian Robert committed
1008
#endif /* NS_IMPL_COCOA */
1009
      if (f > 0)
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
	{
	  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);
	    }
1029 1030 1031 1032 1033
	  else if (retval == 0)
	    {
	      fprintf (stderr, "Error: server did not start correctly\n");
	      exit (1);
	    }
1034 1035 1036 1037

	  close (daemon_pipe[0]);
	  exit (0);
	}
1038 1039 1040
      if (f < 0)
	{
	  fprintf (stderr, "Cannot fork!\n");
1041
	  exit (1);
1042 1043
	}

1044 1045
#ifdef NS_IMPL_COCOA
      {
Adrian Robert's avatar
Adrian Robert committed
1046
        /* In orig process, forked as child, OR in exec'd. */
1047
        if (!dname_arg || !strchr (dname_arg, '\n'))
Adrian Robert's avatar
Adrian Robert committed
1048
          {  /* In orig, child: now exec w/special daemon name. */
1049
            char fdStr[80];
1050 1051 1052 1053
	    int fdStrlen =
	      snprintf (fdStr, sizeof fdStr,
			"--daemon=\n%d,%d\n%s", daemon_pipe[0],
			daemon_pipe[1], dname_arg ? dname_arg : "");
1054

1055
	    if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1056 1057 1058 1059 1060 1061 1062 1063
              {
                fprintf (stderr, "daemon: child name too long\n");
                exit (1);
              }

            argv[skip_args] = fdStr;

            execv (argv[0], argv);
1064
            fprintf (stderr, "emacs daemon: exec failed: %d\n", errno);
1065 1066 1067
            exit (1);
          }

Adrian Robert's avatar
Adrian Robert committed
1068
        /* In exec'd: parse special dname into pipe and name info. */
1069 1070 1071 1072
        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
1073
            exit (1);
1074 1075 1076 1077
          }
        dname_arg2[0] = '\0';
        sscanf (dname_arg, "\n%d,%d\n%s", &(daemon_pipe[0]), &(daemon_pipe[1]),
                dname_arg2);
1078
        dname_arg = *dname_arg2 ? dname_arg2 : NULL;
1079
      }
Adrian Robert's avatar
Adrian Robert committed
1080
#endif /* NS_IMPL_COCOA */
1081

1082 1083
      if (dname_arg)
       	daemon_name = xstrdup (dname_arg);