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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1993-1995, 1997-1999, 2001-2019 Free Software
Paul Eggert's avatar
Paul Eggert committed
4
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 <https://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

Paul Eggert's avatar
Paul Eggert committed
21
#define INLINE EXTERN_INLINE
22
#include <config.h>
Paul Eggert's avatar
Paul Eggert committed
23

Jim Blandy's avatar
Jim Blandy committed
24
#include <errno.h>
25
#include <fcntl.h>
Paul Eggert's avatar
Paul Eggert committed
26
#include <stdlib.h>
Jim Blandy's avatar
Jim Blandy committed
27 28

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

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

33
#define MAIN_PROGRAM
34
#include "lisp.h"
35
#include "sysstdio.h"
36

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

45
#if defined WINDOWSNT || defined HAVE_NTGUI
Daniel Colascione's avatar
Daniel Colascione committed
46 47
#include "w32select.h"
#include "w32font.h"
48
#include "w32common.h"
Daniel Colascione's avatar
Daniel Colascione committed
49 50
#endif

51
#if defined CYGWIN
Daniel Colascione's avatar
Daniel Colascione committed
52
#include "cygw32.h"
53 54
#endif

55 56
#ifdef MSDOS
#include <binary-io.h>
Eli Zaretskii's avatar
Eli Zaretskii committed
57
#include "dosfns.h"
58 59
#endif

60
#ifdef HAVE_LIBSYSTEMD
61 62 63
# include <systemd/sd-daemon.h>
# include <sys/socket.h>
#endif
64

65 66 67 68
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

Paul Eggert's avatar
Paul Eggert committed
69
#include "bignum.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
70
#include "intervals.h"
71
#include "character.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
72
#include "buffer.h"
Stefan Monnier's avatar
Stefan Monnier committed
73
#include "window.h"
Paul Eggert's avatar
Paul Eggert committed
74
#include "xwidget.h"
75
#include "atimer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
76
#include "blockinput.h"
77
#include "syssignal.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
78
#include "process.h"
79
#include "frame.h"
80
#include "termhooks.h"
Andreas Schwab's avatar
Andreas Schwab committed
81
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
82
#include "keymap.h"
Paul Eggert's avatar
Paul Eggert committed
83 84 85 86
#include "category.h"
#include "charset.h"
#include "composite.h"
#include "dispextern.h"
87
#include "ptr-bounds.h"
88
#include "regex-emacs.h"
89
#include "sheap.h"
Paul Eggert's avatar
Paul Eggert committed
90
#include "syntax.h"
91
#include "sysselect.h"
Paul Eggert's avatar
Paul Eggert committed
92
#include "systime.h"
93
#include "puresize.h"
Jim Blandy's avatar
Jim Blandy committed
94

Paul Eggert's avatar
Paul Eggert committed
95
#include "getpagesize.h"
Ted Zlatanov's avatar
Ted Zlatanov committed
96 97
#include "gnutls.h"

98
#ifdef PROFILING
99 100
# include <sys/gmon.h>
extern void moncontrol (int mode);
101 102 103 104 105
# ifdef __MINGW32__
extern unsigned char etext asm ("etext");
# else
extern char etext;
# endif
106 107
#endif

108 109 110 111
#ifdef HAVE_SETLOCALE
#include <locale.h>
#endif

112 113 114 115
#if HAVE_WCHAR_H
# include <wchar.h>
#endif

116 117 118 119 120
#ifdef HAVE_SETRLIMIT
#include <sys/time.h>
#include <sys/resource.h>
#endif

Daniel Colascione's avatar
Daniel Colascione committed
121 122 123
#include "pdumper.h"
#include "epaths.h"

Glenn Morris's avatar
Glenn Morris committed
124
static const char emacs_version[] = PACKAGE_VERSION;
125
static const char emacs_copyright[] = COPYRIGHT;
Glenn Morris's avatar
Glenn Morris committed
126
static const char emacs_bugreport[] = PACKAGE_BUGREPORT;
127

128 129
/* 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
130

131 132 133 134 135
#ifdef WINDOWSNT
/* Cache for externally loaded libraries.  */
Lisp_Object Vlibrary_cache;
#endif

Daniel Colascione's avatar
Daniel Colascione committed
136
struct gflags gflags;
137
bool initialized;
Jim Blandy's avatar
Jim Blandy committed
138

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

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

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

152
#if defined GNU_LINUX && !defined CANNOT_DUMP
153
/* The gap between BSS end and heap start as far as we can tell.  */
154 155
static uprintmax_t heap_bss_diff;
#endif
156

157 158
/* To run as a background daemon under Cocoa or Windows,
   we must do a fork+exec, not a simple fork.
159 160 161 162 163 164 165 166 167 168

   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. */
169
#if defined NS_IMPL_COCOA || (defined HAVE_NTGUI && defined CYGWIN)
170 171 172
# define DAEMON_MUST_EXEC
#endif

173 174
/* True means running Emacs without interactive terminal.  */
bool noninteractive;
Jim Blandy's avatar
Jim Blandy committed
175

176 177
/* True means remove site-lisp directories from load-path.  */
bool no_site_lisp;
178

Paul Eggert's avatar
Paul Eggert committed
179 180 181
/* True means put details like time stamps into builds.  */
bool build_details;

182 183
/* Name for the server started by the daemon.*/
static char *daemon_name;
184

185 186 187
/* 0 not a daemon, 1 new-style (foreground), 2 old-style (background).  */
int daemon_type;

188
#ifndef WINDOWSNT
189 190
/* Pipe used to send exit notification to the background daemon parent at
   startup.  On Windows, we use a kernel event instead.  */
191
static int daemon_pipe[2];
192 193 194
#else
HANDLE w32_daemon_event;
#endif
195

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

200 201 202
/* The name of the working directory, or NULL if this info is unavailable.  */
char const *emacs_wd;

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

Paul Eggert's avatar
Paul Eggert committed
206
/* C99 needs each string to be at most 4095 characters, and the usage
Kenichi Handa's avatar
Kenichi Handa committed
207
   strings below are split to not overflow this limit.  */
Paul Eggert's avatar
Paul Eggert committed
208 209
static char const *const usage_message[] =
  { "\
Gerd Moellmann's avatar
Gerd Moellmann committed
210 211 212 213 214
\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\
215
Run M-x info RET m emacs RET m emacs invocation RET inside Emacs to\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
216 217 218 219
read the main documentation for these command-line arguments.\n\
\n\
Initialization options:\n\
\n\
Paul Eggert's avatar
Paul Eggert committed
220 221
",
    "\
Kenichi Handa's avatar
Kenichi Handa committed
222
--batch                     do not do interactive display; implies -q\n\
223
--chdir DIR                 change to directory DIR\n\
224 225
--daemon, --bg-daemon[=NAME] start a (named) server in the background\n\
--fg-daemon[=NAME]          start a (named) server in the foreground\n\
Kenichi Handa's avatar
Kenichi Handa committed
226 227
--debug-init                enable Emacs Lisp debugger for init file\n\
--display, -d DISPLAY       use X server DISPLAY\n\
228 229 230
",
#ifdef HAVE_MODULES
    "\
231
--module-assertions         assert behavior of dynamic modules\n\
Paul Eggert's avatar
Paul Eggert committed
232
",
233 234 235 236 237
#endif
#ifdef HAVE_PDUMPER
    "\
--dump-file FILE            read dumped state from FILE\n\
",
238
#endif
Paul Eggert's avatar
Paul Eggert committed
239
    "\
Paul Eggert's avatar
Paul Eggert committed
240
--no-build-details          do not add build details such as time stamps\n\
Kenichi Handa's avatar
Kenichi Handa committed
241 242
--no-desktop                do not load a saved desktop\n\
--no-init-file, -q          load neither ~/.emacs nor default.el\n\
243
--no-loadup, -nl            do not load loadup.el into bare Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
244
--no-site-file              do not load site-start.el\n\
245
--no-x-resources            do not load X resources\n\
246
--no-site-lisp, -nsl        do not add site-lisp directories to load-path\n\
Kenichi Handa's avatar
Kenichi Handa committed
247
--no-splash                 do not display a splash screen on startup\n\
248
--no-window-system, -nw     do not communicate with X, ignoring $DISPLAY\n\
Paul Eggert's avatar
Paul Eggert committed
249 250
",
    "\
251 252
--quick, -Q                 equivalent to:\n\
                              -q --no-site-file --no-site-lisp --no-splash\n\
253
                              --no-x-resources\n\
Kenichi Handa's avatar
Kenichi Handa committed
254 255 256
--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\
Paul Eggert's avatar
Paul Eggert committed
257 258 259
\n\
",
    "\
Gerd Moellmann's avatar
Gerd Moellmann committed
260 261
Action options:\n\
\n\
262
FILE                    visit FILE\n\
263 264
+LINE                   go to line LINE in next FILE\n\
+LINE:COLUMN            go to line LINE, column COLUMN, in next FILE\n\
265
--directory, -L DIR     prepend DIR to load-path (with :DIR, append DIR)\n\
Kenichi Handa's avatar
Kenichi Handa committed
266 267
--eval EXPR             evaluate Emacs Lisp expression EXPR\n\
--execute EXPR          evaluate Emacs Lisp expression EXPR\n\
Paul Eggert's avatar
Paul Eggert committed
268 269
",
    "\
270 271
--file FILE             visit FILE\n\
--find-file FILE        visit FILE\n\
Kenichi Handa's avatar
Kenichi Handa committed
272 273 274 275
--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\
276
--visit FILE            visit FILE\n\
Paul Eggert's avatar
Paul Eggert committed
277 278 279
\n\
",
    "\
280
Display options:\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
281
\n\
Kenichi Handa's avatar
Kenichi Handa committed
282
--background-color, -bg COLOR   window background color\n\
283 284
--basic-display, -D             disable many display features;\n\
                                  used for debugging Emacs\n\
Kenichi Handa's avatar
Kenichi Handa committed
285 286
--border-color, -bd COLOR       main border color\n\
--border-width, -bw WIDTH       width of main border\n\
Paul Eggert's avatar
Paul Eggert committed
287 288
",
    "\
289
--color, --color=MODE           override color mode for character terminals;\n\
290 291
                                  MODE defaults to `auto', and\n\
                                  can also be `never', `always',\n\
Kenichi Handa's avatar
Kenichi Handa committed
292 293 294 295
                                  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\
Paul Eggert's avatar
Paul Eggert committed
296 297
",
    "\
Kenichi Handa's avatar
Kenichi Handa committed
298
--fullheight, -fh               make the first frame high as the screen\n\
299
--fullscreen, -fs               make the first frame fullscreen\n\
Kenichi Handa's avatar
Kenichi Handa committed
300
--fullwidth, -fw                make the first frame wide as the screen\n\
301
--maximized, -mm                make the first frame maximized\n\
Kenichi Handa's avatar
Kenichi Handa committed
302
--geometry, -g GEOMETRY         window geometry\n\
Paul Eggert's avatar
Paul Eggert committed
303 304
",
    "\
Jan Djärv's avatar
Jan Djärv committed
305
--no-bitmap-icon, -nbi          do not use picture of gnu for Emacs icon\n\
Kenichi Handa's avatar
Kenichi Handa committed
306 307 308 309 310
--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\
Paul Eggert's avatar
Paul Eggert committed
311 312
",
    "\
313
--no-blinking-cursor, -nbc      disable blinking cursor\n\
Kenichi Handa's avatar
Kenichi Handa committed
314 315 316 317
--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
318
--parent-id XID                 set parent window\n\
Kenichi Handa's avatar
Kenichi Handa committed
319 320
--help                          display this help and exit\n\
--version                       output version information and exit\n\
Paul Eggert's avatar
Paul Eggert committed
321 322 323
\n\
",
    "\
Gerd Moellmann's avatar
Gerd Moellmann committed
324 325 326 327 328
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\
329
the operation of Emacs.  See the main documentation.\n\
330
\n\
Glenn Morris's avatar
Glenn Morris committed
331
Report bugs to " PACKAGE_BUGREPORT ".  First, please see the Bugs\n\
Gerd Moellmann's avatar
Gerd Moellmann committed
332
section of the Emacs manual or the file BUGS.\n"
Paul Eggert's avatar
Paul Eggert committed
333
  };
Gerd Moellmann's avatar
Gerd Moellmann committed
334

Jim Blandy's avatar
Jim Blandy committed
335

336 337
/* True if handling a fatal error already.  */
bool fatal_error_in_progress;
338

339 340 341
#ifdef HAVE_NS
/* NS autrelease pool, for memory management.  */
static void *ns_pool;
342 343
#endif

344 345 346 347 348 349 350
#if !HAVE_SETLOCALE
static char *
setlocale (int cat, char const *locale)
{
  return 0;
}
#endif
351

352 353 354 355 356 357 358 359 360 361 362 363 364
/* True if the current system locale uses UTF-8 encoding.  */
static bool
using_utf8 (void)
{
#ifdef HAVE_WCHAR_H
  wchar_t wc;
  mbstate_t mbs = { 0 };
  return mbrtowc (&wc, "\xc4\x80", 2, &mbs) == 2 && wc == 0x100;
#else
  return false;
#endif
}

365

366 367 368
/* Report a fatal error due to signal SIG, output a backtrace of at
   most BACKTRACE_LIMIT lines, and exit.  */
_Noreturn void
369
terminate_due_to_signal (int sig, int backtrace_limit)
Jim Blandy's avatar
Jim Blandy committed
370 371
{
  signal (sig, SIG_DFL);
372

373
  if (attempt_orderly_shutdown_on_fatal_signal)
374
    {
375 376 377 378 379 380 381
      /* If fatal error occurs in code below, avoid infinite recursion.  */
      if (! fatal_error_in_progress)
        {
          fatal_error_in_progress = 1;

          totally_unblock_input ();
          if (sig == SIGTERM || sig == SIGHUP || sig == SIGINT)
382
            Fkill_emacs (make_fixnum (sig));
383 384 385 386

          shut_down_emacs (sig, Qnil);
          emacs_backtrace (backtrace_limit);
        }
387
    }
Jim Blandy's avatar
Jim Blandy committed
388

389
  /* Signal the same code; this time it will really be fatal.
390 391
     Since we're in a signal handler, the signal is blocked, so we
     have to unblock it if we want to really receive it.  */
392
#ifndef MSDOS
Paul Eggert's avatar
Paul Eggert committed
393 394 395
  {
    sigset_t unblocked;
    sigemptyset (&unblocked);
396
    sigaddset (&unblocked, sig);
Paul Eggert's avatar
Paul Eggert committed
397 398
    pthread_sigmask (SIG_UNBLOCK, &unblocked, 0);
  }
399
#endif
400

401
  emacs_raise (sig);
402 403 404

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

Andreas Schwab's avatar
Andreas Schwab committed
409
static void
410
init_cmdargs (int argc, char **argv, int skip_args, char const *original_pwd)
Jim Blandy's avatar
Jim Blandy committed
411
{
412
  int i;
413
  Lisp_Object name, dir, handler;
414
  ptrdiff_t count = SPECPDL_INDEX ();
415
  Lisp_Object raw_name;
416
  AUTO_STRING (slash_colon, "/:");
Jim Blandy's avatar
Jim Blandy committed
417

418 419 420
  initial_argv = argv;
  initial_argc = argc;

421 422 423 424 425 426 427 428 429 430 431 432
#ifdef WINDOWSNT
  /* Must use argv[0] converted to UTF-8, as it begets many standard
     file and directory names.  */
  {
    char argv0[MAX_UTF8_PATH];

    if (filename_from_ansi (argv[0], argv0) == 0)
      raw_name = build_unibyte_string (argv0);
    else
      raw_name = build_unibyte_string (argv[0]);
  }
#else
433
  raw_name = build_unibyte_string (argv[0]);
434
#endif
435 436 437

  /* Add /: to the front of the name
     if it would otherwise be treated as magic.  */
438 439
  handler = Ffind_file_name_handler (raw_name, Qt);
  if (! NILP (handler))
440
    raw_name = concat2 (slash_colon, raw_name);
441 442 443 444

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

445 446 447 448 449 450
  /* 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,
451
		       Vexec_suffixes, &found, make_fixnum (X_OK), false);
452
      if (yes == 1)
453 454 455
	{
	  /* Add /: to the front of the name
	     if it would otherwise be treated as magic.  */
456 457
	  handler = Ffind_file_name_handler (found, Qt);
	  if (! NILP (handler))
458
	    found = concat2 (slash_colon, found);
459 460
	  Vinvocation_directory = Ffile_name_directory (found);
	}
461
    }
462

463 464
  if (!NILP (Vinvocation_directory)
      && NILP (Ffile_name_absolute_p (Vinvocation_directory)))
465 466
    /* Emacs was started with relative path, like ./emacs.
       Make it absolute.  */
467
    {
468 469 470
      Lisp_Object odir =
	original_pwd ? build_unibyte_string (original_pwd) : Qnil;

471 472
      Vinvocation_directory = Fexpand_file_name (Vinvocation_directory, odir);
    }
473

474 475 476 477
  Vinstallation_directory = Qnil;

  if (!NILP (Vinvocation_directory))
    {
478 479 480
      if (NILP (Vpurify_flag) && !NILP (Ffboundp (Qfile_truename)))
        Vinvocation_directory = call1 (Qfile_truename, Vinvocation_directory);

481
      dir = Vinvocation_directory;
482 483 484 485 486 487 488 489 490 491
#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
492 493 494
      name = Fexpand_file_name (Vinvocation_name, dir);
      while (1)
	{
495
	  Lisp_Object tem, lib_src_exists;
496 497
	  Lisp_Object etc_exists, info_exists;

498 499 500 501 502
	  /* 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);
503

504
#ifdef MSDOS
505 506 507 508 509
	  /* 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);
510 511 512
#else
	  info_exists = Qnil;
#endif
513 514

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
515
	    {
516 517 518
	      tem = Fexpand_file_name (build_string ("etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
519
		{
Daniel Colascione's avatar
Daniel Colascione committed
520
                  Vinstallation_directory = Ffile_name_as_directory (dir);
521
		  break;
522 523 524 525
		}
	    }

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

529 530 531

#ifdef MSDOS
	  /* See the MSDOS commentary above.  */
532 533
	  tem = Fexpand_file_name (build_string ("../info"), dir);
	  info_exists = Ffile_exists_p (tem);
534 535 536
#else
	  info_exists = Qnil;
#endif
537 538

	  if (!NILP (lib_src_exists) || !NILP (info_exists))
539
	    {
540 541 542
	      tem = Fexpand_file_name (build_string ("../etc"), dir);
	      etc_exists = Ffile_exists_p (tem);
	      if (!NILP (etc_exists))
543
		{
544
		  tem = Fexpand_file_name (build_string (".."), dir);
Daniel Colascione's avatar
Daniel Colascione committed
545
                  Vinstallation_directory = Ffile_name_as_directory (tem);
546
		  break;
547 548 549 550 551 552 553 554
		}
	    }

	  /* 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))
	    {
555
	      name = Fexpand_file_name (tem, dir);
556 557 558 559 560 561 562
	      dir = Ffile_name_directory (name);
	    }
	  else
	    break;
	}
    }

Jim Blandy's avatar
Jim Blandy committed
563 564 565 566 567
  Vcommand_line_args = Qnil;

  for (i = argc - 1; i >= 0; i--)
    {
      if (i == 0 || i > skip_args)
568 569 570
	/* 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
571
	Vcommand_line_args
572
	  = Fcons (build_unibyte_string (argv[i]), Vcommand_line_args);
Jim Blandy's avatar
Jim Blandy committed
573
    }
574 575

  unbind_to (count, Qnil);
Jim Blandy's avatar
Jim Blandy committed
576
}
577 578

DEFUN ("invocation-name", Finvocation_name, Sinvocation_name, 0, 0, 0,
Pavel Janík's avatar
Pavel Janík committed
579 580
       doc: /* Return the program name that was used to run Emacs.
Any directory names are omitted.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
581
  (void)
582 583 584 585
{
  return Fcopy_sequence (Vinvocation_name);
}

586
DEFUN ("invocation-directory", Finvocation_directory, Sinvocation_directory,
Pavel Janík's avatar
Pavel Janík committed
587 588
       0, 0, 0,
       doc: /* Return the directory name in which the Emacs executable was located.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
589
  (void)
590 591 592 593
{
  return Fcopy_sequence (Vinvocation_directory);
}

Jim Blandy's avatar
Jim Blandy committed
594

Karl Heuer's avatar
Karl Heuer committed
595 596 597 598 599 600 601 602 603
/* 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.  */
604

605
static bool
606 607
argmatch (char **argv, int argc, const char *sstr, const char *lstr,
          int minlen, char **valptr, int *skipptr)
Karl Heuer's avatar
Karl Heuer committed
608
{
609
  char *p = NULL;
610
  ptrdiff_t arglen;
611 612 613 614 615 616 617
  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
618 619 620 621 622 623 624 625 626 627 628 629 630
  if (arg == NULL)
    return 0;
  if (strcmp (arg, sstr) == 0)
    {
      if (valptr != NULL)
	{
	  *valptr = argv[*skipptr+2];
	  *skipptr += 2;
	}
      else
	*skipptr += 1;
      return 1;
    }
631
  arglen = (valptr != NULL && (p = strchr (arg, '=')) != NULL
Karl Heuer's avatar
Karl Heuer committed
632
	    ? p - arg : strlen (arg));
633
  if (lstr == 0 || arglen < minlen || strncmp (arg, lstr, arglen) != 0)
Karl Heuer's avatar
Karl Heuer committed
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
    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;
    }
}

Paul Eggert's avatar
Paul Eggert committed
658 659 660 661 662 663 664
/* 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)
    {
665
      emacs_perror ("Write error to standard output");
Paul Eggert's avatar
Paul Eggert committed
666 667 668
      _exit (EXIT_FAILURE);
    }

669 670 671 672 673
  /* Do not close stderr if addresses are being sanitized, as the
     sanitizer might report to stderr after this function is
     invoked.  */
  if (!ADDRESS_SANITIZER && close_stream (stderr) != 0)
    _exit (EXIT_FAILURE);
Paul Eggert's avatar
Paul Eggert committed
674
}
675

Daniel Colascione's avatar
Daniel Colascione committed
676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
#ifdef HAVE_PDUMPER

static const char *
dump_error_to_string (enum pdumper_load_result result)
{
  switch (result)
    {
    case PDUMPER_LOAD_SUCCESS:
      return "success";
    case PDUMPER_LOAD_OOM:
      return "out of memory";
    case PDUMPER_NOT_LOADED:
      return "not loaded";
    case PDUMPER_LOAD_FILE_NOT_FOUND:
      return "could not open file";
    case PDUMPER_LOAD_BAD_FILE_TYPE:
      return "not a dump file";
    case PDUMPER_LOAD_FAILED_DUMP:
      return "dump file is result of failed dump attempt";
    case PDUMPER_LOAD_VERSION_MISMATCH:
      return "not built for this Emacs executable";
    default:
      return "generic error";
    }
}

static enum pdumper_load_result
load_pdump (int argc, char **argv)
{
  const char *const suffix = ".pdmp";
  const char *const argv0_base = "emacs";
  enum pdumper_load_result result;
#ifdef WINDOWSNT
  size_t argv0_len;
#endif

  /* TODO: maybe more thoroughly scrub process environment in order to
     make this use case (loading a pdumper image in an unexeced emacs)
     possible?  Right now, we assume that things we don't touch are
     zero-initialized, and in an unexeced Emacs, this assumption
     doesn't hold.  */
  if (initialized)
    fatal ("cannot load pdumper image in unexeced Emacs");

  /* Look for an explicitly-specified dump file.  */
  const char *path_exec = PATH_EXEC;
722 723 724 725 726 727 728 729 730 731
  char *dump_file = NULL;
  int skip_args = 0;
  while (skip_args < argc - 1)
    {
      if (argmatch (argv, argc, "-dump-file", "--dump-file", 6,
		    &dump_file, &skip_args)
	  || argmatch (argv, argc, "--", NULL, 2, NULL, &skip_args))
	break;
      skip_args++;
    }
Daniel Colascione's avatar
Daniel Colascione committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

  result = PDUMPER_NOT_LOADED;
  if (dump_file)
    result = pdumper_load (dump_file);

  if (dump_file && result != PDUMPER_LOAD_SUCCESS)
    fatal ("could not load dump file \"%s\": %s",
           dump_file, dump_error_to_string (result));

  if (result == PDUMPER_LOAD_SUCCESS)
    goto out;

  /* Look for a dump file in the same directory as the executable; it
     should have the same basename.  */

  dump_file = alloca (strlen (argv[0]) + strlen (suffix) + 1);
#ifdef WINDOWSNT
  /* Remove the .exe extension if present.  */
  argv0_len = strlen (argv[0]);
  if (argv0_len >= 4 && c_strcasecmp (argv[0] + argv0_len - 4, ".exe") == 0)
752
    sprintf (dump_file, "%.*s%s", (int)(argv0_len - 4), argv[0], suffix);
Daniel Colascione's avatar
Daniel Colascione committed
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
  else
#endif
  sprintf (dump_file, "%s%s", argv[0], suffix);

  result = pdumper_load (dump_file);
  if (result == PDUMPER_LOAD_SUCCESS)
    goto out;

  if (result != PDUMPER_LOAD_FILE_NOT_FOUND)
    fatal ("could not load dump file \"%s\": %s",
           dump_file, dump_error_to_string (result));

  /* Finally, look for "emacs.pdmp" in PATH_EXEC.  We hardcode
     "emacs" in "emacs.pdmp" so that the Emacs binary still works
     if the user copies and renames it.

     FIXME: this doesn't work with emacs-XX.YY.ZZ.pdmp versioned files.  */
#ifdef WINDOWSNT
  /* On MS-Windows, PATH_EXEC normally starts with a literal
     "%emacs_dir%", so it will never work without some tweaking.  */
  path_exec = w32_relocate (path_exec);
#endif
  dump_file = alloca (strlen (path_exec)
                      + 1
                      + strlen (argv0_base)
                      + strlen (suffix)
                      + 1);
  sprintf (dump_file, "%s%c%s%s",
           path_exec, DIRECTORY_SEP, argv0_base, suffix);
  result = pdumper_load (dump_file);
  if (result != PDUMPER_LOAD_SUCCESS)
    dump_file = NULL;

 out:
  return result;
}
#endif /* HAVE_PDUMPER */

791 792
/* ARGSUSED */
int
Dan Nicolaescu's avatar
Dan Nicolaescu committed
793
main (int argc, char **argv)
794
{
Paul Eggert's avatar
Paul Eggert committed
795 796 797 798
  /* Variable near the bottom of the stack, and aligned appropriately
     for pointers.  */
  void *stack_bottom_variable;

799
  bool do_initial_setlocale;
800
  bool no_loadup = false;
Richard M. Stallman's avatar
Richard M. Stallman committed
801
  char *junk = 0;
802
  char *dname_arg = 0;
803
#ifdef DAEMON_MUST_EXEC
804 805
  char dname_arg2[80];
#endif
806
  char *ch_to_dir = 0;
807

808
  /* If we use --chdir, this records the original directory.  */
809
  char const *original_pwd = 0;
810

811
  /* Record (approximately) where the stack begins.  */
Paul Eggert's avatar
Paul Eggert committed
812
  stack_bottom = (char *) &stack_bottom_variable;
813

Daniel Colascione's avatar
Daniel Colascione committed
814
  const char *dump_mode = NULL;
815 816 817 818 819 820 821 822 823
  int skip_args = 0;
  char *temacs = NULL;
  while (skip_args < argc - 1)
    {
      if (argmatch (argv, argc, "-temacs", "--temacs", 8, &temacs, &skip_args)
	  || argmatch (argv, argc, "--", NULL, 2, NULL, &skip_args))
	break;
      skip_args++;
    }
Daniel Colascione's avatar
Daniel Colascione committed
824 825
#ifdef HAVE_PDUMPER
  bool attempt_load_pdump = false;
826
#endif
827

Daniel Colascione's avatar
Daniel Colascione committed
828 829 830 831
  /* Look for this argument first, before any heap allocation, so we
     can set heap flags properly if we're going to unexec.  */
  if (!initialized && temacs)
    {
832
#ifndef CANNOT_DUMP
Daniel Colascione's avatar
Daniel Colascione committed
833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
      if (strcmp (temacs, "dump") == 0 ||
          strcmp (temacs, "bootstrap") == 0)
        gflags.will_dump_with_unexec_ = true;
#endif
#ifdef HAVE_PDUMPER
      if (strcmp (temacs, "pdump") == 0 ||
          strcmp (temacs, "pbootstrap") == 0)
        gflags.will_dump_with_pdumper_ = true;
#endif
#if defined (HAVE_PDUMPER) || !defined (CANNOT_DUMP)
      if (strcmp (temacs, "bootstrap") == 0 ||
          strcmp (temacs, "pbootstrap") == 0)
        gflags.will_bootstrap_ = true;
      gflags.will_dump_ =
        will_dump_with_pdumper_p () ||
        will_dump_with_unexec_p ();
      if (will_dump_p ())
        dump_mode = temacs;
#endif
      if (!dump_mode)
        fatal ("Invalid temacs mode '%s'", temacs);
    }
  else if (temacs)
856
    {
Daniel Colascione's avatar
Daniel Colascione committed
857
      fatal ("--temacs not supported for unexeced emacs");
858
    }
Daniel Colascione's avatar
Daniel Colascione committed
859 860 861 862
  else
    {
      eassert (!initialized);
      eassert (!temacs);
863
#ifdef HAVE_PDUMPER
Daniel Colascione's avatar
Daniel Colascione committed
864 865 866 867 868 869 870
      attempt_load_pdump = true;
#endif
    }

#ifndef CANNOT_DUMP
  if (!will_dump_with_unexec_p ())
    gflags.will_not_unexec_ = true;
871
#endif
872

873
#if defined WINDOWSNT || defined HAVE_NTGUI
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
  /* Grab our malloc arena space now, before anything important
     happens.  This relies on the static heap being needed only in
     temacs and only if we are going to dump with unexec.  */
  bool use_dynamic_heap = false;
  if (strstr (argv[0], "temacs") != NULL)
    {
      eassert (temacs);
      /* Note that gflags are set at this point only if we have been
	 called with the --temacs=METHOD option.  We assume here that
	 temacs is always called that way, otherwise the functions
	 that rely on gflags, like will_dump_with_pdumper_p below,
	 will not do their job.  */
      use_dynamic_heap = will_dump_with_pdumper_p ();
    }
  else
    use_dynamic_heap = true;
  init_heap (use_dynamic_heap);
891
  /* Set global variables used to detect Windows version.  Do this as
892
     early as possible.  (w32proc.c calls this function as well, but
893 894
     the additional call here is harmless.) */
  cache_system_info ();
895 896 897 898 899
#ifdef WINDOWSNT
  /* On Windows 9X, we have to load UNICOWS.DLL as early as possible,
     to have non-stub implementations of APIs we need to convert file
     names between UTF-8 and the system's ANSI codepage.  */
  maybe_load_unicows_dll ();
900 901 902
  /* Initialize the codepage for file names, needed to decode
     non-ASCII file names during startup.  */
  w32_init_file_name_codepage ();
903 904
  /* Initialize the startup directory, needed for emacs_wd below.  */
  w32_init_current_directory ();
905
#endif
906
  w32_init_main_thread ();
907 908
#endif

Daniel Colascione's avatar
Daniel Colascione committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
#ifdef HAVE_PDUMPER
  if (attempt_load_pdump)
    load_pdump (argc, argv);
#endif

  argc = maybe_disable_address_randomization (
    will_dump_with_unexec_p (), argc, argv);

#if defined (GNU_LINUX) && !defined (CANNOT_DUMP)
  if (!initialized)
    {
      char *heap_start = my_heap_start ();
      heap_bss_diff = heap_start - max (my_endbss, my_endbss_static);
    }
#endif

925 926 927 928 929
#ifdef RUN_TIME_REMAP
  if (initialized)
    run_time_remap (argv[0]);
#endif

930
/* If using unexmacosx.c (set by s/darwin.h), we must do this. */
931
#if defined DARWIN_OS && !defined CANNOT_DUMP
932 933 934 935
  if (!initialized)
    unexec_init_emacs_zone ();
#endif

936
  init_standard_fds ();
Paul Eggert's avatar
Paul Eggert committed
937 938
  atexit (close_output_streams);

939
  sort_args (argc, argv);
940 941
  argc = 0;
  while (argv[argc]) argc++;
942

943
  skip_args = 0;
944
  if (argmatch (argv, argc, "-version", "--version", 3, NULL, &skip_args))
945
    {
946 947
      const char *version, *copyright;
      if (initialized)
948
	{
949 950 951 952 953
	  Lisp_Object tem, tem2;
	  tem = Fsymbol_value (intern_c_string ("emacs-version"));
	  tem2 = Fsymbol_value (intern_c_string ("emacs-copyright"));
	  if (!STRINGP (tem))
	    {
954
	      fprintf (stderr, "Invalid value of 'emacs-version'\n");
955 956 957 958
	      exit (1);
	    }
	  if (!STRINGP (tem2))
	    {
959
	      fprintf (stderr, "Invalid value of 'emacs-copyright'\n");
960 961 962 963
	      exit (1);
	    }
	  else
	    {
964 965
	      version = SSDATA (tem);
	      copyright = SSDATA (tem2);
966
	    }
967
	}
968 969
      else
	{
970 971
	  version = emacs_version;
	  copyright = emacs_copyright;
972
	}
973
      printf ("%s %s\n", PACKAGE_NAME, version);
974
      printf ("%s\n", copyright);
975 976
      printf ("%s comes with ABSOLUTELY NO WARRANTY.\n", PACKAGE_NAME);
      printf ("You may redistribute copies of %s\n", PACKAGE_NAME);
977 978 979 980
      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);
981
    }
982

983 984
  emacs_wd = emacs_get_current_dir_name ();

985
  if (argmatch (argv, argc, "-chdir", "--chdir", 4, &ch_to_dir, &skip_args))
986
    {
987 988 989 990 991 992 993 994
#ifdef WINDOWSNT
      /* argv[] array is kept in its original ANSI codepage encoding,
	 we need to convert to UTF-8, for chdir to work.  */
      char newdir[MAX_UTF8_PATH];

      filename_from_ansi (ch_to_dir, newdir);
      ch_to_dir = newdir;
#endif
995
      if (chdir (ch_to_dir) != 0)
996 997 998 999 1000
        {
          fprintf (stderr, "%s: Can't chdir to %s: %s\n",
                   argv[0], ch_to_dir, strerror (errno));
          exit (1);
        }
1001
      original_pwd = emacs_wd;
1002 1003 1004 1005
#ifdef WINDOWSNT
      /* Reinitialize Emacs's notion of the startup directory.  */
      w32_init_current_directory ();
#endif
1006
      emacs_wd = emacs_get_current_dir_name ();
1007
    }
1008

1009 1010 1011 1012 1013 1014 1015
#if defined (HAVE_SETRLIMIT) && defined (RLIMIT_STACK) && !defined (CYGWIN)
  /* 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.  And it's not needed on Cygwin, since emacs
     is built with an 8MB stack.  Moreover, the setrlimit call can
     cause problems on Cygwin
     (https://www.cygwin.com/ml/cygwin/2015-07/msg00096.html).  */
Paul Eggert's avatar
Paul Eggert committed
1016 1017
  struct rlimit rlim;
  if (getrlimit (RLIMIT_STACK, &rlim) == 0
1018
      &&<