nt/inc/ms-w32.h

   1 /* System description file for Windows NT.
   2
   3 Copyright (C) 1993-1995, 2001-2016 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or (at
  10 your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 /* Define symbols to identify the version of Unix this is.
  21    Define all the symbols that apply correctly.  */
  22
  23 #ifndef WINDOWSNT
  24 #define WINDOWSNT
  25 #endif
  26
  27 #include <mingw_time.h>
  28
  29 /* MinGW-w64 gcc does not automotically define a macro for
  30    differentiating it fom MinGW gcc. We need to test the presence of
  31    __MINGW64_VERSION_MAJOR in _mingw.h: */
  32 #ifdef __MINGW32__
  33 # include <_mingw.h>
  34 # ifdef __MINGW64_VERSION_MAJOR
  35 #  define MINGW_W64
  36 # endif
  37 #endif
  38
  39 /* #undef const */
  40
  41 /* Number of chars of output in the buffer of a stdio stream. */
  42 #ifdef __GNU_LIBRARY__
  43 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->__bufp - (FILE)->__buffer)
  44 #else
  45 #define PENDING_OUTPUT_COUNT(FILE) ((FILE)->_ptr - (FILE)->_base)
  46 #endif
  47
  48 /* If you are compiling with a non-C calling convention but need to
  49    declare vararg routines differently, put it here.  */
  50 #define _VARARGS_ __cdecl
  51
  52 /* If you are providing a function to something that will call the
  53    function back (like a signal handler and signal, or main) its calling
  54    convention must be whatever standard the libraries expect.  */
  55 #define _CALLBACK_ __cdecl
  56
  57 /* Define HAVE_TIMEVAL if the system supports the BSD style clock values.
  58    Look in <sys/time.h> for a timeval structure.  */
  59 #define HAVE_TIMEVAL 1
  60
  61 /* And the select implementation does 1-byte read-ahead waiting
  62    for received packets, so datagrams are broken too.  */
  63 #define BROKEN_DATAGRAM_SOCKETS 1
  64
  65 #define MAIL_USE_SYSTEM_LOCK 1
  66
  67 /* Define to 1 if GCC-style __attribute__ ((__aligned__ (expr))) works. */
  68 #ifdef __GNUC__
  69 #define HAVE_ATTRIBUTE_ALIGNED 1
  70 #endif
  71
  72 /* Define to 1 if strtold conforms to C99. */
  73 #ifdef __GNUC__
  74 #define HAVE_C99_STRTOLD 1
  75 #endif
  76
  77 #if (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
  78 # ifndef HAVE___BUILTIN_UNWIND_INIT
  79 #  define HAVE___BUILTIN_UNWIND_INIT 1
  80 # endif
  81 #endif
  82
  83 /* This isn't perfect, as some systems might have the page file in
  84    another place.  Also, I suspect that the time stamp of that file
  85    might also change when Windows enlarges the file due to
  86    insufficient VM.  Still, this seems to be the most reliable way;
  87    the alternative (of using GetSystemTimes) won't work on laptops
  88    that hibernate, because the system clock is stopped then.  Other
  89    possibility would be to run "net statistics workstation" and parse
  90    the output, but that's gross.  So this should do; if the file is
  91    not there, the boot time will be returned as zero, and filelock.c
  92    already handles that.  */
  93 #define BOOT_TIME_FILE "C:/pagefile.sys"
  94
  95 /* ============================================================ */
  96
  97 /* Here, add any special hacks needed to make Emacs work on this
  98    system.  For example, you might define certain system call names
  99    that don't exist on your system, or that do different things on
 100    your system and must be used only through an encapsulation (which
 101    you should place, by convention, in sysdep.c).  */
 102
 103 #ifdef __GNUC__
 104 #ifndef __cplusplus
 105 #undef inline
 106 #endif
 107 #else  /* MSVC */
 108 #define inline __inline
 109 #endif
 110
 111 #ifdef __GNUC__
 112 /* config.h may have defined already.  */
 113 # ifndef restrict
 114 #  define restrict __restrict__
 115 # endif
 116 #else
 117   /* FIXME: should we define to __restrict, which MSVC supports? */
 118 # define restrict
 119 #endif
 120
 121 /* `mode_t' is not defined for MSVC. Define. */
 122 #ifdef _MSC_VER
 123 typedef unsigned short mode_t;
 124 #endif
 125
 126 /* A va_copy replacement for MSVC.  */
 127 #ifdef _MSC_VER
 128 # ifdef _WIN64
 129 #  ifndef va_copy               /* Need to be checked (?) */
 130 #   define va_copy(d,s) ((d) = (s))
 131 #  endif
 132 # else  /* not _WIN64 */
 133 #  define va_copy(d,s) ((d) = (s))
 134 # endif  /* not _WIN64 */
 135 #endif   /* _MSC_VER */
 136
 137 #ifndef WINDOWSNT
 138 /* Some of the files of Emacs which are intended for use with other
 139    programs assume that if you have a config.h file, you must declare
 140    the type of getenv.  */
 141 extern char *getenv ();
 142 #endif
 143
 144 /* Prevent accidental use of features unavailable in older Windows
 145    versions we still support.  MinGW64 defines this to a higher value
 146    in its system headers, and is not really compatible with values
 147    lower than 0x0500, so leave it alone.  */
 148 #ifndef MINGW_W64
 149 # define _WIN32_WINNT 0x0400
 150 #endif
 151
 152 /* Make a leaner executable.  */
 153 #define WIN32_LEAN_AND_MEAN 1
 154
 155 #include <sys/types.h>
 156
 157 #ifndef MAXPATHLEN
 158 #define MAXPATHLEN      _MAX_PATH
 159 #endif
 160
 161 /* This is used to hold UTF-8 encoded file names.  */
 162 #define MAX_UTF8_PATH   (MAXPATHLEN * 4)
 163
 164 #ifdef HAVE_NTGUI
 165 # ifndef HAVE_WINDOW_SYSTEM
 166 #  define HAVE_WINDOW_SYSTEM 1
 167 #  define POLL_FOR_INPUT 1
 168 # endif
 169 #endif
 170
 171 /* Get some redefinitions in place.  */
 172
 173 #ifdef emacs
 174
 175 #ifdef MINGW_W64
 176 /* MinGW64 specific stuff.  */
 177 /* Make sure 'struct timespec' and 'struct timezone' are defined.  */
 178 #include <sys/types.h>
 179 #include <time.h>
 180 /* This prototype avoids MinGW64 compiler warnings due to the fact
 181    that time.h is included before localtime is redirected to
 182    sys_localtime below.  */
 183 extern struct tm * sys_localtime (const time_t *);
 184 /* MinGW64 uses a 2-argument _setjmp, and setjmp is a macro defined to
 185    supply the 2nd arg correctly, so don't use _setjmp directly in that
 186    case.  */
 187 #undef HAVE__SETJMP
 188
 189 /* Unlike MS and mingw.org, MinGW64 doesn't define gai_strerror as an
 190    inline function in a system header file, and instead seems to
 191    require to link against ws2_32.a.  But we don't want to link with
 192    -lws2_32, as that would make Emacs dependent on the respective DLL.
 193    So MinGW64 is amply punished here by the following:  */
 194 #undef HAVE_GAI_STRERROR
 195 #endif
 196
 197 /* The following is needed for recovery from C stack overflows.  */
 198 #include <setjmp.h>
 199 typedef jmp_buf sigjmp_buf;
 200 #ifdef MINGW_W64
 201 /* Evidently, MinGW64's longjmp crashes when invoked from an exception
 202    handler, see https://sourceforge.net/p/mingw-w64/mailman/message/32421953/.
 203    This seems to be an unsolved problem in the MinGW64 runtime.  So we
 204    use the GCC intrinsics instead.  FIXME.  */
 205 #define sigsetjmp(j,m) __builtin_setjmp(j)
 206 #else
 207 #define sigsetjmp(j,m) setjmp(j)
 208 #endif
 209 extern void w32_reset_stack_overflow_guard (void);
 210
 211 #ifdef _MSC_VER
 212 #include <sys/timeb.h>
 213 #include <sys/stat.h>
 214 #include <signal.h>
 215
 216 /* MSVC gets link-time errors without these redirections.  */
 217 #define fstat(a, b) sys_fstat(a, b)
 218 #define stat(a, b)  sys_stat(a, b)
 219 #define utime       sys_utime
 220 #endif
 221
 222 /* Calls that are emulated or shadowed.  */
 223 #undef chdir
 224 #define chdir   sys_chdir
 225 #undef chmod
 226 #define chmod   sys_chmod
 227 #undef close
 228 #define close   sys_close
 229 #undef creat
 230 #define creat   sys_creat
 231 #define ctime   sys_ctime
 232 #undef dup
 233 #define dup     sys_dup
 234 #undef dup2
 235 #define dup2    sys_dup2
 236 #define fopen   sys_fopen
 237 #define link    sys_link
 238 #define localtime sys_localtime
 239 #define mkdir   sys_mkdir
 240 #undef open
 241 #define open    sys_open
 242 #undef read
 243 #define read    sys_read
 244 #define rename  sys_rename
 245 #define rmdir   sys_rmdir
 246 #define select  sys_select
 247 #define pselect sys_select
 248 #define sleep   sys_sleep
 249 #define strerror sys_strerror
 250 #undef unlink
 251 #define unlink  sys_unlink
 252 #undef opendir
 253 #define opendir sys_opendir
 254 #undef closedir
 255 #define closedir sys_closedir
 256 #undef readdir
 257 #define readdir sys_readdir
 258 #undef seekdir
 259 #define seekdir sys_seekdir
 260 /* This prototype is needed because some files include config.h
 261    _after_ the standard headers, so sys_unlink gets no prototype from
 262    stdio.h or io.h.  */
 263 extern int sys_unlink (const char *);
 264 #undef write
 265 #define write   sys_write
 266 #undef umask
 267 #define umask   sys_umask
 268 extern int sys_umask (int);
 269
 270 /* Subprocess calls that are emulated.  */
 271 #define spawnve sys_spawnve
 272 #define kill    sys_kill
 273 #define signal  sys_signal
 274
 275 /* Internal signals.  */
 276 #define emacs_raise(sig) emacs_abort()
 277
 278 /* termcap.c calls that are emulated.  */
 279 #define tputs   sys_tputs
 280 #define tgetstr sys_tgetstr
 281
 282 /* cm.c calls that are emulated.  */
 283 #define chcheckmagic sys_chcheckmagic
 284 #define cmcostinit   sys_cmcostinit
 285 #define cmgoto       sys_cmgoto
 286 #define cmputc       sys_cmputc
 287 #define Wcm_clear    sys_Wcm_clear
 288
 289 #endif /* emacs */
 290
 291 /* Map to MSVC names.  */
 292 #define execlp    _execlp
 293 #define execvp    _execvp
 294 #include <stdint.h>             /* for intptr_t */
 295 extern intptr_t _execvp (const char *, char **);
 296 extern intptr_t execve (const char *, char * const *, char * const *);
 297 #define fdatasync _commit
 298 #define fdopen    _fdopen
 299 #define fsync     _commit
 300 #define ftruncate _chsize
 301 #define getpid    _getpid
 302 #ifdef _MSC_VER
 303 typedef int pid_t;
 304 #define snprintf  _snprintf
 305 #define strtoll   _strtoi64
 306 #define copysign  _copysign
 307 #endif
 308 #define isatty    _isatty
 309 #define _longjmp  longjmp
 310 /* MinGW64 defines lseek to invoke lseek64.  */
 311 #ifndef lseek
 312 #define lseek     _lseek
 313 #endif
 314 #define popen     _popen
 315 #define pclose    _pclose
 316 #define strdup    _strdup
 317 #define strupr    _strupr
 318 #define strnicmp  _strnicmp
 319 #define stricmp   _stricmp
 320 #define tzset     _tzset
 321
 322 /* We cannot include system header process.h, since there's src/process.h.  */
 323 int _getpid (void);
 324
 325 /* Include time.h before redirecting tzname, since MSVC's time.h
 326    defines _tzname to call a function, but also declares tzname a
 327    2-element array.  Having the redirection before including the
 328    header thus has the effect of declaring a function that returns an
 329    array, and triggers an error message.  */
 330 #include <time.h>
 331 #define tzname    _tzname
 332
 333 /* Required for functions in lib/time_r.c, since we don't use lib/time.h.  */
 334 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
 335 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
 336
 337 #ifdef _MSC_VER
 338 /* This is hacky, but is necessary to avoid warnings about macro
 339    redefinitions using the MSVC compilers, since, when __STDC__ is
 340    undefined or zero, those compilers declare functions like fileno,
 341    lseek, and chdir, for which we defined macros above.  */
 342 #ifndef __STDC__
 343 #define __STDC__ 1
 344 #define MUST_UNDEF__STDC__
 345 #endif
 346 #include <direct.h>
 347 #include <io.h>
 348 #include <stdio.h>
 349 #ifdef MUST_UNDEF__STDC__
 350 #undef __STDC__
 351 #undef MUST_UNDEF__STDC__
 352 #endif
 353 #else  /* !_MSC_VER */
 354 #include <direct.h>
 355 #include <io.h>
 356 #include <stdio.h>
 357 #endif  /* !_MSC_VER */
 358 #ifndef fileno
 359 #define fileno    _fileno
 360 #endif
 361
 362 /* Defines that we need that aren't in the standard signal.h.  */
 363 #define SIGHUP  1               /* Hang up */
 364 #define SIGQUIT 3               /* Quit process */
 365 #define SIGTRAP 5               /* Trace trap */
 366 #define SIGKILL 9               /* Die, die die */
 367 #define SIGPIPE 13              /* Write on pipe with no readers */
 368 #define SIGALRM 14              /* Alarm */
 369 #define SIGCHLD 18              /* Death of child */
 370 #define SIGPROF 19              /* Profiling */
 371
 372 #ifndef NSIG
 373 #define NSIG 23
 374 #endif
 375
 376 #ifndef ENOTSUP
 377 #define ENOTSUP ENOSYS
 378 #endif
 379
 380 /* In case lib/errno.h is not used.  */
 381 #ifndef EOPNOTSUPP
 382 #define EOPNOTSUPP 130
 383 #endif
 384
 385 #ifdef _MSC_VER
 386 typedef int sigset_t;
 387 typedef int ssize_t;
 388 #endif
 389
 390 #ifdef MINGW_W64
 391 #ifndef _POSIX
 392 typedef _sigset_t sigset_t;
 393 #endif
 394 #endif
 395
 396 typedef void (_CALLBACK_ *signal_handler) (int);
 397 extern signal_handler sys_signal (int, signal_handler);
 398
 399 struct sigaction {
 400   int sa_flags;
 401   void (_CALLBACK_ *sa_handler)(int);
 402   sigset_t sa_mask;
 403 };
 404 #define SA_RESTART      0
 405 #define SIG_BLOCK       1
 406 #define SIG_SETMASK     2
 407 #define SIG_UNBLOCK     3
 408
 409 extern int sigemptyset (sigset_t *);
 410 extern int sigaddset (sigset_t *, int);
 411 extern int sigfillset (sigset_t *);
 412 extern int sigprocmask (int, const sigset_t *, sigset_t *);
 413 /* MinGW64 defines pthread_sigmask as zero in its pthread_signal.h
 414    header, but we have an implementation for that function in w32proc.c.  */
 415 #ifdef pthread_sigmask
 416 #undef pthread_sigmask
 417 #endif
 418 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
 419 extern int sigismember (const sigset_t *, int);
 420 extern int setpgrp (int, int);
 421 extern int sigaction (int, const struct sigaction *, struct sigaction *);
 422 extern int alarm (int);
 423
 424 extern int sys_kill (pid_t, int);
 425
 426
 427 /* For integration with MSDOS support.  */
 428 #define getdisk()               (_getdrive () - 1)
 429 #ifdef emacs
 430 #define getdefdir(_drv, _buf)   ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
 431 #else
 432 #define getdefdir(_drv, _buf)   _getdcwd (_drv, _buf, MAXPATHLEN)
 433 #endif
 434
 435 #ifndef EMACS_CONFIGURATION
 436 extern char *get_emacs_configuration (void);
 437 extern char *get_emacs_configuration_options (void);
 438 #define EMACS_CONFIGURATION     get_emacs_configuration ()
 439 #define EMACS_CONFIG_OPTIONS    get_emacs_configuration_options ()
 440 #endif
 441
 442 /* Define this so that winsock.h definitions don't get included with
 443    windows.h.  For this to have proper effect, config.h must always be
 444    included before windows.h.  */
 445 #define _WINSOCKAPI_    1
 446 #define _WINSOCK_H
 447
 448 /* Defines size_t and alloca ().  */
 449 #include <stdlib.h>
 450 #include <sys/stat.h>
 451 #ifdef _MSC_VER
 452 #define alloca _alloca
 453 #else
 454 #include <malloc.h>
 455 #endif
 456
 457 #ifdef emacs
 458
 459 typedef void * (* malloc_fn)(size_t);
 460 typedef void * (* realloc_fn)(void *, size_t);
 461 typedef void (* free_fn)(void *);
 462
 463 extern void *malloc_before_dump(size_t);
 464 extern void *realloc_before_dump(void *, size_t);
 465 extern void free_before_dump(void *);
 466 extern void *malloc_after_dump(size_t);
 467 extern void *realloc_after_dump(void *, size_t);
 468 extern void free_after_dump(void *);
 469
 470 extern void *malloc_after_dump_9x(size_t);
 471 extern void *realloc_after_dump_9x(void *, size_t);
 472 extern void free_after_dump_9x(void *);
 473
 474 extern malloc_fn the_malloc_fn;
 475 extern realloc_fn the_realloc_fn;
 476 extern free_fn the_free_fn;
 477
 478 #define malloc(size) (*the_malloc_fn)(size)
 479 #define free(ptr)   (*the_free_fn)(ptr)
 480 #define realloc(ptr, size) (*the_realloc_fn)(ptr, size)
 481
 482 #endif
 483
 484 /* Define for those source files that do not include enough NT system files.  */
 485 #ifndef NULL
 486 #ifdef __cplusplus
 487 #define NULL    0
 488 #else
 489 #define NULL    ((void *)0)
 490 #endif
 491 #endif
 492
 493 /* For proper declaration of environ.  */
 494 #ifndef sys_nerr
 495 #define sys_nerr _sys_nerr
 496 #endif
 497
 498 /* This must be after including stdlib.h, which defines putenv on MinGW.  */
 499 #ifdef putenv
 500 # undef putenv
 501 #endif
 502 #define putenv    sys_putenv
 503 extern int sys_putenv (char *);
 504
 505 extern int getloadavg (double *, int);
 506 extern int getpagesize (void);
 507
 508 extern void * memrchr (void const *, int, size_t);
 509
 510 extern int mkostemp (char *, int);
 511
 512
 513 #if defined (__MINGW32__)
 514
 515 /* Define to 1 if the system has the type `long long int'. */
 516 # ifndef HAVE_LONG_LONG_INT
 517 #  define HAVE_LONG_LONG_INT 1
 518 # endif
 519
 520 /* Define to 1 if the system has the type `unsigned long long int'. */
 521 # ifndef HAVE_UNSIGNED_LONG_LONG_INT
 522 #  define HAVE_UNSIGNED_LONG_LONG_INT 1
 523 # endif
 524
 525 #endif
 526
 527 #ifdef _MSC_VER
 528 # if defined(_WIN64)
 529 typedef __int64 EMACS_INT;
 530 typedef unsigned __int64 EMACS_UINT;
 531 #  define EMACS_INT_MAX           LLONG_MAX
 532 #  define PRIuMAX                 "llu"
 533 #  define pI                      "ll"
 534 /* Fix a bug in MSVC headers : stdint.h */
 535 #  define _INTPTR 2
 536 # elif defined(_WIN32)
 537 /* Temporarily disable wider-than-pointer integers until they're tested more.
 538    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 539
 540 #  ifdef WIDE_EMACS_INT
 541
 542 /* Use pre-C99-style 64-bit integers.  */
 543 typedef __int64 EMACS_INT;
 544 typedef unsigned __int64 EMACS_UINT;
 545 #   define EMACS_INT_MAX           LLONG_MAX
 546 #   define PRIuMAX                 "llu"
 547 #   define pI                     "I64"
 548 #  else
 549 typedef int EMACS_INT;
 550 typedef unsigned int EMACS_UINT;
 551 #   define EMACS_INT_MAX           LONG_MAX
 552 #   define PRIuMAX                 "lu"
 553 #   define pI                     "l"
 554 #  endif
 555 # endif
 556 #endif
 557
 558 /* We need a little extra space, see ../../lisp/loadup.el.  */
 559 #define SYSTEM_PURESIZE_EXTRA 50000
 560
 561 #define DATA_START      get_data_start ()
 562
 563 /* For unexec to work on Alpha systems, we need to put Emacs'
 564    initialized data into a separate section from the CRT initialized
 565    data (because the Alpha linker freely reorders data variables, even
 566    across libraries, so our data and the CRT data get intermingled).
 567
 568    Starting with MSVC 5.0, we must also place the uninitialized data
 569    into its own section.  VC5 intermingles uninitialized data from the CRT
 570    between Emacs' static uninitialized data and its public uninitialized
 571    data.  A separate .bss section for Emacs groups both static and
 572    public uninitialized together.
 573
 574    Note that unexw32.c relies on this fact, and must be modified
 575    accordingly if this section name is changed, or if this pragma is
 576    removed.  Also, obviously, all files that define initialized data
 577    must include config.h to pick up this pragma.  */
 578
 579 /* Names must be < 8 bytes.  */
 580 #ifdef _MSC_VER
 581 #pragma data_seg("EMDATA")
 582 #pragma bss_seg("EMBSS")
 583 #endif
 584
 585 /* #define FULL_DEBUG */
 586 /* #define EMACSDEBUG */
 587
 588 #ifdef EMACSDEBUG
 589 extern void _DebPrint (const char *fmt, ...);
 590 #define DebPrint(stuff) _DebPrint stuff
 591 #else
 592 #define DebPrint(stuff)
 593 #endif
 594
 595 #ifdef _MSC_VER
 596 #if _MSC_VER >= 800 && !defined(__cplusplus)
 597 /* Unnamed type definition in parentheses.
 598    A structure, union, or enumerated type with no name is defined in a
 599    parenthetical expression.  The type definition is meaningless.  */
 600 #pragma warning(disable:4116)
 601 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
 602    data A floating point type was converted to an integer type.  A
 603    possible loss of data may have occurred.  */
 604 #pragma warning(disable:4244)
 605 /* Negative integral constant converted to unsigned type.
 606    An expression converts a negative integer constant to an unsigned type.
 607    The result of the expression is probably meaningless.  */
 608 #pragma warning(disable:4308)
 609 #endif
 610 #endif
 611
 612 /* Event name for when emacsclient starts the Emacs daemon on Windows.  */
 613 #define W32_DAEMON_EVENT "EmacsServerEvent"
 614
 615 /* ============================================================ */