emacs.c 70.3 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>

30
#include <ignore-value.h>
31 32

#include "lisp.h"
33

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

134 135
Lisp_Object Qfile_name_handler_alist;

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

138 139
Lisp_Object Qkill_emacs;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

310

311

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

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

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

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

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

344
  emacs_raise (sig);
345 346 347

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

#ifdef SIGDANGER

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

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

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

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

379 380 381
  initial_argv = argv;
  initial_argc = argc;

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

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

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

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

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

417 418 419 420 421
  Vinstallation_directory = Qnil;

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

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

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

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

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

470 471 472

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#endif /* DOUG_LEA_MALLOC */

678

679 680
/* ARGSUSED */
int
Dan Nicolaescu's avatar
Dan Nicolaescu committed
681
main (int argc, char **argv)
682
{
683
#if GC_MARK_STACK
684 685
  Lisp_Object dummy;
#endif
686
  char stack_bottom_variable;
687
  bool do_initial_setlocale;
688
  bool dumping;
689 690 691 692
  int skip_args = 0;
#ifdef HAVE_SETRLIMIT
  struct rlimit rlim;
#endif
693
  bool no_loadup = 0;
Richard M. Stallman's avatar
Richard M. Stallman committed
694
  char *junk = 0;
695
  char *dname_arg = 0;
696
#ifdef DAEMON_MUST_EXEC
697
  char dname_arg2[80];
698
#endif
699
  char *ch_to_dir;
700

701
#if GC_MARK_STACK
702 703 704
  stack_base = &dummy;
#endif

705 706 707 708 709
#if defined (USE_GTK) && defined (G_SLICE_ALWAYS_MALLOC)
  /* This is used by the Cygwin build.  */
  setenv ("G_SLICE", "always-malloc", 1);
#endif

710
#ifdef GNU_LINUX
711 712 713 714 715 716 717 718 719 720
  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);
    }
721
#endif
722

723 724 725 726 727
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

728 729
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
#ifdef DARWIN_OS
730 731 732 733
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

734
  sort_args (argc, argv);
735 736
  argc = 0;
  while (argv[argc]) argc++;
737

738
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
739
    {
740 741
      const char *version, *copyright;
      if (initialized)
742
	{
743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
	  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
	    {
758 759
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
760
	    }
761
	}
762 763
      else
	{
764 765
	  version = emacs_version;
	  copyright = emacs_copyright;
766
	}
767 768 769 770 771 772 773 774
      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);
775
    }
776 777 778 779 780 781 782 783

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

785 786
  dumping = !initialized && (strcmp (argv[argc - 1], "dump") == 0
			     || strcmp (argv[argc - 1], "bootstrap") == 0);
787

788
#ifdef HAVE_PERSONALITY_LINUX32
789
  if (dumping && ! getenv ("EMACS_HEAP_EXEC"))
790
    {
791
      static char heapexec[] = "EMACS_HEAP_EXEC=true";
792
      /* Set this so we only do this once.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
793
      putenv (heapexec);
794

795 796
      /* A flag to turn off address randomization which is introduced
         in linux kernel shipped with fedora core 4 */
797
#define ADD_NO_RANDOMIZE 0x0040000
798
      personality (PER_LINUX32 | ADD_NO_RANDOMIZE);
799 800
#undef  ADD_NO_RANDOMIZE

801
      execvp (argv[0], argv);
802

803 804
      /* If the exec fails, try to dump anyway.  */
      perror ("execvp");
805 806 807
    }
#endif /* HAVE_PERSONALITY_LINUX32 */

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

844 845
      setrlimit (RLIMIT_STACK, &rlim);
    }
846
#endif /* HAVE_SETRLIMIT and RLIMIT_STACK */
847

Jim Blandy's avatar
Jim Blandy committed
848 849 850 851
  /* Record (approximately) where the stack begins.  */
  stack_bottom = &stack_bottom_variable;

  clearerr (stdin);
852

Jim Blandy's avatar
Jim Blandy committed
853
#ifndef SYSTEM_MALLOC
854 855
  /* Arrange to get warning messages as memory fills up.  */
  memory_warnings (0, malloc_warning);
856

857
  /* Call malloc at least once, to run malloc_initialize_hook.
858 859
     Also call realloc and free for consistency.  */
  free (realloc (malloc (4), 4));
860

Jim Blandy's avatar
Jim Blandy committed
861 862
#endif	/* not SYSTEM_MALLOC */

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

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

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

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

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

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

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

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

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

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

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

991
#ifndef DAEMON_MUST_EXEC
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");
996
#endif /* USE_GTK */
997
      f = fork ();
998
#else /* DAEMON_MUST_EXEC */
999 1000 1001 1002
      if (!dname_arg || !strchr (dname_arg, '\n'))
	  f = fork ();  /* in orig */
      else
	  f = 0;  /* in exec'd */
1003
#endif /* !DAEMON_MUST_EXEC */
1004
      if (f > 0)
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
	{
	  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);
	    }
1024 1025 1026 1027 1028
	  else if (retval == 0)
	    {
	      fprintf (stderr, "Error: server did not start correctly\n");
	      exit (1);
	    }
1029 1030 1031 1032

	  close (daemon_pipe[0]);
	  exit (0);
	}
1033 1034 1035
      if (f < 0)
	{
	  fprintf (stderr, "Cannot fork!\n");
1036
	  exit (1);
1037 1038
	}

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

1050
	    if (! (0 <= fdStrlen && fdStrlen < sizeof fdStr))
1051 1052 1053 1054 1055 1056 1057 1058
              {
                fprintf (stderr, "daemon: child name too long\n");
                exit (1);
              }

            argv[skip_args] = fdStr;

            execv (argv[0], argv);
1059
            fprintf (stderr, "emacs daemon: exec failed: %d\n", errno);
1060 1061 1062
            exit (1);
          }

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