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