nt/inc/ms-w32.h

   1 /* System description file for Windows NT.
   2
   3 Copyright (C) 1993-1995, 2001-2017 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 # undef _WIN32_WINNT
 150 # define _WIN32_WINNT 0x0400
 151 #endif
 152
 153 /* Make a leaner executable.  */
 154 #define WIN32_LEAN_AND_MEAN 1
 155
 156 #include <sys/types.h>
 157
 158 #ifndef MAXPATHLEN
 159 #define MAXPATHLEN      _MAX_PATH
 160 #endif
 161
 162 /* This is used to hold UTF-8 encoded file names.  */
 163 #define MAX_UTF8_PATH   (MAXPATHLEN * 4)
 164
 165 #ifdef HAVE_NTGUI
 166 # ifndef HAVE_WINDOW_SYSTEM
 167 #  define HAVE_WINDOW_SYSTEM 1
 168 #  define POLL_FOR_INPUT 1
 169 # endif
 170 #endif
 171
 172 /* Get some redefinitions in place.  */
 173
 174 #ifdef emacs
 175
 176 #ifdef MINGW_W64
 177 /* MinGW64 specific stuff.  */
 178 /* Make sure 'struct timespec' and 'struct timezone' are defined.  */
 179 #include <sys/types.h>
 180 #include <time.h>
 181 /* This prototype avoids MinGW64 compiler warnings due to the fact
 182    that time.h is included before localtime is redirected to
 183    sys_localtime below.  */
 184 extern struct tm * sys_localtime (const time_t *);
 185 /* MinGW64 uses a 2-argument _setjmp, and setjmp is a macro defined to
 186    supply the 2nd arg correctly, so don't use _setjmp directly in that
 187    case.  */
 188 #undef HAVE__SETJMP
 189
 190 /* Unlike MS and mingw.org, MinGW64 doesn't define gai_strerror as an
 191    inline function in a system header file, and instead seems to
 192    require to link against ws2_32.a.  But we don't want to link with
 193    -lws2_32, as that would make Emacs dependent on the respective DLL.
 194    So MinGW64 is amply punished here by the following:  */
 195 #undef HAVE_GAI_STRERROR
 196 #endif
 197
 198 /* The following is needed for recovery from C stack overflows.  */
 199 #include <setjmp.h>
 200 typedef jmp_buf sigjmp_buf;
 201 #ifdef MINGW_W64
 202 /* Evidently, MinGW64's longjmp crashes when invoked from an exception
 203    handler, see https://sourceforge.net/p/mingw-w64/mailman/message/32421953/.
 204    This seems to be an unsolved problem in the MinGW64 runtime.  So we
 205    use the GCC intrinsics instead.  FIXME.  */
 206 #define sigsetjmp(j,m) __builtin_setjmp(j)
 207 #else
 208 #define sigsetjmp(j,m) setjmp(j)
 209 #endif
 210 extern void w32_reset_stack_overflow_guard (void);
 211
 212 #ifdef _MSC_VER
 213 #include <sys/timeb.h>
 214 #include <sys/stat.h>
 215 #include <signal.h>
 216
 217 /* MSVC gets link-time errors without these redirections.  */
 218 #define fstat(a, b) sys_fstat(a, b)
 219 #define stat(a, b)  sys_stat(a, b)
 220 #define utime       sys_utime
 221 #endif
 222
 223 /* Calls that are emulated or shadowed.  */
 224 #undef chdir
 225 #define chdir   sys_chdir
 226 #undef chmod
 227 #define chmod   sys_chmod
 228 #undef close
 229 #define close   sys_close
 230 #undef creat
 231 #define creat   sys_creat
 232 #define ctime   sys_ctime
 233 #undef dup
 234 #define dup     sys_dup
 235 #undef dup2
 236 #define dup2    sys_dup2
 237 #define fopen   sys_fopen
 238 #define link    sys_link
 239 #define localtime sys_localtime
 240 #define mkdir   sys_mkdir
 241 #undef open
 242 #define open    sys_open
 243 #undef read
 244 #define read    sys_read
 245 #define rename  sys_rename
 246 #define rmdir   sys_rmdir
 247 #define select  sys_select
 248 #define pselect sys_select
 249 #define sleep   sys_sleep
 250 #define strerror sys_strerror
 251 #undef unlink
 252 #define unlink  sys_unlink
 253 #undef opendir
 254 #define opendir sys_opendir
 255 #undef closedir
 256 #define closedir sys_closedir
 257 #undef readdir
 258 #define readdir sys_readdir
 259 #undef seekdir
 260 #define seekdir sys_seekdir
 261 /* This prototype is needed because some files include config.h
 262    _after_ the standard headers, so sys_unlink gets no prototype from
 263    stdio.h or io.h.  */
 264 extern int sys_unlink (const char *);
 265 #undef write
 266 #define write   sys_write
 267 #undef umask
 268 #define umask   sys_umask
 269 extern int sys_umask (int);
 270
 271 /* Subprocess calls that are emulated.  */
 272 #define spawnve sys_spawnve
 273 #define kill    sys_kill
 274 #define signal  sys_signal
 275
 276 /* Internal signals.  */
 277 #define emacs_raise(sig) emacs_abort()
 278
 279 /* termcap.c calls that are emulated.  */
 280 #define tputs   sys_tputs
 281 #define tgetstr sys_tgetstr
 282
 283 /* cm.c calls that are emulated.  */
 284 #define chcheckmagic sys_chcheckmagic
 285 #define cmcostinit   sys_cmcostinit
 286 #define cmgoto       sys_cmgoto
 287 #define cmputc       sys_cmputc
 288 #define Wcm_clear    sys_Wcm_clear
 289
 290 #endif /* emacs */
 291
 292 /* Map to MSVC names.  */
 293 #define execlp    _execlp
 294 #define execvp    _execvp
 295 #include <stdint.h>             /* for intptr_t */
 296 extern intptr_t _execvp (const char *, char **);
 297 #ifdef MINGW_W64
 298 /* GCC 6 has a builtin execve with the prototype shown below.  MinGW64
 299    changed the prototype in its process.h to match that, although the
 300    library function still calls _execve, which still returns intptr_t.
 301    However, using the prototype with intptr_t causes GCC to emit
 302    warnings.  Fortunately, execve is not used in the MinGW build, but
 303    the code that references it is still compiled.  */
 304 extern int execve (const char *, char * const *, char * const *);
 305 #else
 306 extern intptr_t execve (const char *, char * const *, char * const *);
 307 #endif
 308 #define fdatasync _commit
 309 #define fdopen    _fdopen
 310 #define fsync     _commit
 311 #define ftruncate _chsize
 312 #define getpid    _getpid
 313 #ifdef _MSC_VER
 314 typedef int pid_t;
 315 #define snprintf  _snprintf
 316 #define strtoll   _strtoi64
 317 #define copysign  _copysign
 318 #endif
 319 #define isatty    _isatty
 320 #define _longjmp  longjmp
 321 /* MinGW64 defines lseek to invoke lseek64.  */
 322 #ifndef lseek
 323 #define lseek     _lseek
 324 #endif
 325 #define popen     _popen
 326 #define pclose    _pclose
 327 #define strdup    _strdup
 328 #define strupr    _strupr
 329 #define strnicmp  _strnicmp
 330 #define stricmp   _stricmp
 331 #define tzset     _tzset
 332
 333 /* We cannot include system header process.h, since there's src/process.h.  */
 334 int _getpid (void);
 335
 336 /* Include time.h before redirecting tzname, since MSVC's time.h
 337    defines _tzname to call a function, but also declares tzname a
 338    2-element array.  Having the redirection before including the
 339    header thus has the effect of declaring a function that returns an
 340    array, and triggers an error message.  */
 341 #include <time.h>
 342 #define tzname    _tzname
 343
 344 /* Required for functions in lib/time_r.c, since we don't use lib/time.h.  */
 345 extern struct tm *gmtime_r (time_t const * restrict, struct tm * restrict);
 346 extern struct tm *localtime_r (time_t const * restrict, struct tm * restrict);
 347
 348 #ifdef _MSC_VER
 349 /* This is hacky, but is necessary to avoid warnings about macro
 350    redefinitions using the MSVC compilers, since, when __STDC__ is
 351    undefined or zero, those compilers declare functions like fileno,
 352    lseek, and chdir, for which we defined macros above.  */
 353 #ifndef __STDC__
 354 #define __STDC__ 1
 355 #define MUST_UNDEF__STDC__
 356 #endif
 357 #include <direct.h>
 358 #include <io.h>
 359 #include <stdio.h>
 360 #ifdef MUST_UNDEF__STDC__
 361 #undef __STDC__
 362 #undef MUST_UNDEF__STDC__
 363 #endif
 364 #else  /* !_MSC_VER */
 365 #include <direct.h>
 366 #include <io.h>
 367 #include <stdio.h>
 368 #endif  /* !_MSC_VER */
 369 #ifndef fileno
 370 #define fileno    _fileno
 371 #endif
 372
 373 /* Defines that we need that aren't in the standard signal.h.  */
 374 #define SIGHUP  1               /* Hang up */
 375 #define SIGQUIT 3               /* Quit process */
 376 #define SIGTRAP 5               /* Trace trap */
 377 #define SIGKILL 9               /* Die, die die */
 378 #define SIGPIPE 13              /* Write on pipe with no readers */
 379 #define SIGALRM 14              /* Alarm */
 380 #define SIGCHLD 18              /* Death of child */
 381 #define SIGPROF 19              /* Profiling */
 382
 383 #ifndef NSIG
 384 #define NSIG 23
 385 #endif
 386
 387 #ifndef ENOTSUP
 388 #define ENOTSUP ENOSYS
 389 #endif
 390
 391 /* In case lib/errno.h is not used.  */
 392 #ifndef EOPNOTSUPP
 393 #define EOPNOTSUPP 130
 394 #endif
 395
 396 #ifdef _MSC_VER
 397 typedef int sigset_t;
 398 typedef int ssize_t;
 399 #endif
 400
 401 #ifdef MINGW_W64
 402 #ifndef _POSIX
 403 typedef _sigset_t sigset_t;
 404 #endif
 405 #endif
 406
 407 typedef void (_CALLBACK_ *signal_handler) (int);
 408 extern signal_handler sys_signal (int, signal_handler);
 409
 410 struct sigaction {
 411   int sa_flags;
 412   void (_CALLBACK_ *sa_handler)(int);
 413   sigset_t sa_mask;
 414 };
 415 #define SA_RESTART      0
 416 #define SIG_BLOCK       1
 417 #define SIG_SETMASK     2
 418 #define SIG_UNBLOCK     3
 419
 420 extern int sigemptyset (sigset_t *);
 421 extern int sigaddset (sigset_t *, int);
 422 extern int sigfillset (sigset_t *);
 423 extern int sigprocmask (int, const sigset_t *, sigset_t *);
 424 /* MinGW64 defines pthread_sigmask as zero in its pthread_signal.h
 425    header, but we have an implementation for that function in w32proc.c.  */
 426 #ifdef pthread_sigmask
 427 #undef pthread_sigmask
 428 #endif
 429 extern int pthread_sigmask (int, const sigset_t *, sigset_t *);
 430 extern int sigismember (const sigset_t *, int);
 431 extern int setpgrp (int, int);
 432 extern int sigaction (int, const struct sigaction *, struct sigaction *);
 433 extern int alarm (int);
 434
 435 extern int sys_kill (pid_t, int);
 436
 437
 438 /* For integration with MSDOS support.  */
 439 #define getdisk()               (_getdrive () - 1)
 440 #ifdef emacs
 441 #define getdefdir(_drv, _buf)   ((_buf[0] = (_drv + 'A' - 1), _buf[1] = ':', _buf[2] = '/', _buf[3] = 0), 1)
 442 #else
 443 #define getdefdir(_drv, _buf)   _getdcwd (_drv, _buf, MAXPATHLEN)
 444 #endif
 445
 446 #ifndef EMACS_CONFIGURATION
 447 extern char *get_emacs_configuration (void);
 448 extern char *get_emacs_configuration_options (void);
 449 #define EMACS_CONFIGURATION     get_emacs_configuration ()
 450 #define EMACS_CONFIG_OPTIONS    get_emacs_configuration_options ()
 451 #endif
 452
 453 /* Define this so that winsock.h definitions don't get included with
 454    windows.h.  For this to have proper effect, config.h must always be
 455    included before windows.h.  */
 456 #define _WINSOCKAPI_    1
 457 #define _WINSOCK_H
 458
 459 /* Defines size_t and alloca ().  */
 460 #include <stdlib.h>
 461 #include <sys/stat.h>
 462 #ifdef _MSC_VER
 463 #define alloca _alloca
 464 #else
 465 #include <malloc.h>
 466 #endif
 467
 468 #ifdef emacs
 469
 470 typedef void * (* malloc_fn)(size_t);
 471 typedef void * (* realloc_fn)(void *, size_t);
 472 typedef void (* free_fn)(void *);
 473
 474 extern void *malloc_before_dump(size_t);
 475 extern void *realloc_before_dump(void *, size_t);
 476 extern void free_before_dump(void *);
 477 extern void *malloc_after_dump(size_t);
 478 extern void *realloc_after_dump(void *, size_t);
 479 extern void free_after_dump(void *);
 480
 481 extern void *malloc_after_dump_9x(size_t);
 482 extern void *realloc_after_dump_9x(void *, size_t);
 483 extern void free_after_dump_9x(void *);
 484
 485 extern malloc_fn the_malloc_fn;
 486 extern realloc_fn the_realloc_fn;
 487 extern free_fn the_free_fn;
 488
 489 #define malloc(size) (*the_malloc_fn)(size)
 490 #define free(ptr)   (*the_free_fn)(ptr)
 491 #define realloc(ptr, size) (*the_realloc_fn)(ptr, size)
 492
 493 #endif
 494
 495 /* Define for those source files that do not include enough NT system files.  */
 496 #ifndef NULL
 497 #ifdef __cplusplus
 498 #define NULL    0
 499 #else
 500 #define NULL    ((void *)0)
 501 #endif
 502 #endif
 503
 504 /* For proper declaration of environ.  */
 505 #ifndef sys_nerr
 506 #define sys_nerr _sys_nerr
 507 #endif
 508
 509 /* This must be after including stdlib.h, which defines putenv on MinGW.  */
 510 #ifdef putenv
 511 # undef putenv
 512 #endif
 513 #define putenv    sys_putenv
 514 extern int sys_putenv (char *);
 515
 516 extern int getloadavg (double *, int);
 517 extern int getpagesize (void);
 518
 519 extern void * memrchr (void const *, int, size_t);
 520
 521 extern int mkostemp (char *, int);
 522
 523
 524 #if defined (__MINGW32__)
 525
 526 /* Define to 1 if the system has the type `long long int'. */
 527 # ifndef HAVE_LONG_LONG_INT
 528 #  define HAVE_LONG_LONG_INT 1
 529 # endif
 530
 531 /* Define to 1 if the system has the type `unsigned long long int'. */
 532 # ifndef HAVE_UNSIGNED_LONG_LONG_INT
 533 #  define HAVE_UNSIGNED_LONG_LONG_INT 1
 534 # endif
 535
 536 #endif
 537
 538 #ifdef _MSC_VER
 539 # if defined(_WIN64)
 540 typedef __int64 EMACS_INT;
 541 typedef unsigned __int64 EMACS_UINT;
 542 #  define EMACS_INT_MAX           LLONG_MAX
 543 #  define PRIuMAX                 "llu"
 544 #  define pI                      "ll"
 545 /* Fix a bug in MSVC headers : stdint.h */
 546 #  define _INTPTR 2
 547 # elif defined(_WIN32)
 548 /* Temporarily disable wider-than-pointer integers until they're tested more.
 549    Build with CFLAGS='-DWIDE_EMACS_INT' to try them out.  */
 550
 551 #  ifdef WIDE_EMACS_INT
 552
 553 /* Use pre-C99-style 64-bit integers.  */
 554 typedef __int64 EMACS_INT;
 555 typedef unsigned __int64 EMACS_UINT;
 556 #   define EMACS_INT_MAX           LLONG_MAX
 557 #   define PRIuMAX                 "llu"
 558 #   define pI                     "I64"
 559 #  else
 560 typedef int EMACS_INT;
 561 typedef unsigned int EMACS_UINT;
 562 #   define EMACS_INT_MAX           LONG_MAX
 563 #   define PRIuMAX                 "lu"
 564 #   define pI                     "l"
 565 #  endif
 566 # endif
 567 #endif
 568
 569 /* We need a little extra space, see ../../lisp/loadup.el.  */
 570 #define SYSTEM_PURESIZE_EXTRA 50000
 571
 572 #define DATA_START      get_data_start ()
 573
 574 /* For unexec to work on Alpha systems, we need to put Emacs'
 575    initialized data into a separate section from the CRT initialized
 576    data (because the Alpha linker freely reorders data variables, even
 577    across libraries, so our data and the CRT data get intermingled).
 578
 579    Starting with MSVC 5.0, we must also place the uninitialized data
 580    into its own section.  VC5 intermingles uninitialized data from the CRT
 581    between Emacs' static uninitialized data and its public uninitialized
 582    data.  A separate .bss section for Emacs groups both static and
 583    public uninitialized together.
 584
 585    Note that unexw32.c relies on this fact, and must be modified
 586    accordingly if this section name is changed, or if this pragma is
 587    removed.  Also, obviously, all files that define initialized data
 588    must include config.h to pick up this pragma.  */
 589
 590 /* Names must be < 8 bytes.  */
 591 #ifdef _MSC_VER
 592 #pragma data_seg("EMDATA")
 593 #pragma bss_seg("EMBSS")
 594 #endif
 595
 596 /* #define FULL_DEBUG */
 597 /* #define EMACSDEBUG */
 598
 599 #ifdef EMACSDEBUG
 600 extern void _DebPrint (const char *fmt, ...);
 601 #define DebPrint(stuff) _DebPrint stuff
 602 #else
 603 #define DebPrint(stuff)
 604 #endif
 605
 606 #ifdef _MSC_VER
 607 #if _MSC_VER >= 800 && !defined(__cplusplus)
 608 /* Unnamed type definition in parentheses.
 609    A structure, union, or enumerated type with no name is defined in a
 610    parenthetical expression.  The type definition is meaningless.  */
 611 #pragma warning(disable:4116)
 612 /* 'argument' : conversion from 'type1' to 'type2', possible loss of
 613    data A floating point type was converted to an integer type.  A
 614    possible loss of data may have occurred.  */
 615 #pragma warning(disable:4244)
 616 /* Negative integral constant converted to unsigned type.
 617    An expression converts a negative integer constant to an unsigned type.
 618    The result of the expression is probably meaningless.  */
 619 #pragma warning(disable:4308)
 620 #endif
 621 #endif
 622
 623 /* Event name for when emacsclient starts the Emacs daemon on Windows.  */
 624 #define W32_DAEMON_EVENT "EmacsServerEvent"
 625
 626 /* ============================================================ */