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

Jim Blandy's avatar
Jim Blandy committed
98 99 100 101
#ifndef O_RDWR
#define O_RDWR 2
#endif

102
static const char emacs_version[] = VERSION;
103
static const char emacs_copyright[] = COPYRIGHT;
104

105 106
/* 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
107

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

113 114 115 116
/* 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
117

118 119 120 121
#ifdef DARWIN_OS
extern void unexec_init_emacs_zone (void);
#endif

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

311

312

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

Jim Blandy's avatar
Jim Blandy committed
321
  /* If fatal error occurs in code below, avoid infinite recursion.  */
322 323 324
  if (! fatal_error_in_progress)
    {
      fatal_error_in_progress = 1;
Jim Blandy's avatar
Jim Blandy committed
325

326
      if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
327 328
        Fkill_emacs (make_number (sig));

329
      shut_down_emacs (sig, Qnil);
330
      emacs_backtrace (backtrace_limit);
331
    }
Jim Blandy's avatar
Jim Blandy committed
332

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

345
  emacs_raise (sig);
346 347 348

  /* This shouldn't be executed, but it prevents a warning.  */
  exit (1);
Jim Blandy's avatar
Jim Blandy committed
349
}
350 351 352

#ifdef SIGDANGER

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

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

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

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

380 381 382
  initial_argv = argv;
  initial_argc = argc;

383 384 385 386
  raw_name = build_string (argv[0]);

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

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

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

412 413
  if (!NILP (Vinvocation_directory)
      && NILP (Ffile_name_absolute_p (Vinvocation_directory)))
414 415
    /* Emacs was started with relative path, like ./emacs.
       Make it absolute.  */
416 417
    Vinvocation_directory = Fexpand_file_name (Vinvocation_directory, Qnil);

418 419 420 421 422
  Vinstallation_directory = Qnil;

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

439 440 441 442 443
	  /* 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);
444

445
#ifdef MSDOS
446 447 448 449 450
	  /* 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);
451 452 453
#else
	  info_exists = Qnil;
#endif
454 455

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

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

471 472 473

#ifdef MSDOS
	  /* See the MSDOS commentary above.  */
474 475
	  tem = Fexpand_file_name (build_string ("../info"), dir);
	  info_exists = Ffile_exists_p (tem);
476 477 478
#else
	  info_exists = Qnil;
#endif
479 480

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

	  /* 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))
	    {
498
	      name = Fexpand_file_name (tem, dir);
499 500 501 502 503 504 505
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
506 507 508 509 510
  Vcommand_line_args = Qnil;

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

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
520
}
521 522

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

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

Jim Blandy's avatar
Jim Blandy committed
538

539 540 541 542 543 544
#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

545
#ifndef ORDINARY_LINK
546 547 548 549 550
/* 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__
551 552 553

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

557
#ifndef GCC_CTORS_IN_LIBC
558 559 560
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
561
/* GNU/Linux has a bug in its library; avoid an error.  */
562
#ifndef GNU_LINUX
563
char * __CTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
564
#endif
565
char * __DTOR_LIST__[2] EXTERNALLY_VISIBLE = { (char *) (-1), 0 };
566
#endif /* GCC_CTORS_IN_LIBC */
567
DEFINE_DUMMY_FUNCTION (__main)
568
#endif /* __GNUC__ */
569
#endif /* ORDINARY_LINK */
570

Karl Heuer's avatar
Karl Heuer committed
571 572 573 574 575 576 577 578 579
/* 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.  */
580

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

634
#ifdef DOUG_LEA_MALLOC
Jim Blandy's avatar
Jim Blandy committed
635

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

652
	  for (p = environ; p && *p; p++)
653 654 655 656 657 658 659 660
	    if (strncmp (*p, "MALLOC_CHECK_=", 14) == 0)
	      {
		do
		  *p = p[1];
		while (*++p);
		break;
	      }
	}
661

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

675
void (*__malloc_initialize_hook) (void) EXTERNALLY_VISIBLE = malloc_initialize_hook;
676 677 678

#endif /* DOUG_LEA_MALLOC */

Paul Eggert's avatar
Paul Eggert committed
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
/* 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",
	       emacs_strerror (errno));
      fflush (stderr);
      _exit (EXIT_FAILURE);
    }

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

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

718
#if GC_MARK_STACK
719 720 721
  stack_base = &dummy;
#endif

722 723 724 725 726
#if defined (USE_GTK) && defined (G_SLICE_ALWAYS_MALLOC)
  /* This is used by the Cygwin build.  */
  setenv ("G_SLICE", "always-malloc", 1);
#endif

727
#ifdef GNU_LINUX
728 729 730 731 732 733 734 735 736 737
  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);
    }
738
#endif
739

740 741 742 743 744
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

745 746
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
#ifdef DARWIN_OS
747 748 749 750
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

751
  sort_args (argc, argv);
752 753
  argc = 0;
  while (argv[argc]) argc++;
754

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

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

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

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

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

818
      execvp (argv[0], argv);
819

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

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

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

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

  clearerr (stdin);
869

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

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

Jim Blandy's avatar
Jim Blandy committed
878 879
#endif	/* not SYSTEM_MALLOC */

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

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

896 897 898 899 900 901 902 903 904 905 906 907 908 909
  /* 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, "");

Paul Eggert's avatar
Paul Eggert committed
910 911
  atexit (close_output_streams);

Jim Blandy's avatar
Jim Blandy committed
912 913
  inhibit_window_system = 0;

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

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

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

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

977 978
  if (argmatch (argv, argc, "-daemon", "--daemon", 5, NULL, &skip_args)
      || argmatch (argv, argc, "-daemon", "--daemon", 5, &dname_arg, &skip_args))
979
    {
980
#ifndef DOS_NT
981 982 983 984 985
      pid_t f;

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

986 987 988 989 990 991 992 993 994 995 996 997 998 999
	 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.

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
	 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);
	}

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

	  close (daemon_pipe[0]);
	  exit (0);
	}
1052 1053 1054
      if (f < 0)
	{
	  fprintf (stderr, "Cannot fork!\n");
1055
	  exit (1);
1056 1057
	}

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

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

            argv[skip_args] = fdStr;

            execv (argv[0], argv);
1078
            fprintf (stderr, "emacs daemon: exec failed: %d\n", errno);
1079 1080 1081
            exit (1);
          }

Adrian Robert's avatar
Adrian Robert committed
1082
        /* In exec'd: parse special dname into pipe and name info. */
1083 1084 1085 1086
        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
1087
            exit (1);
1088 1089 1090