1 /* Process support for GNU Emacs on the Microsoft Windows API.
3 Copyright (C) 1992, 1995, 1999-2017 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
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.
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.
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/>. */
21 Drew Bliss Oct 14, 1993
22 Adapted from alarm.c by Tim Fleehart
25 #define DEFER_MS_W32_H
28 #include <mingw_time.h>
41 /* Include CRT headers *before* ms-w32.h. */
52 #ifdef HAVE_LANGINFO_CODESET
59 #include "w32common.h"
61 #include "syswait.h" /* for WNOHANG */
62 #include "syssignal.h"
66 #define RVA_TO_PTR(var,section,filedata) \
67 ((void *)((section)->PointerToRawData \
68 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
69 + (filedata).file_base))
71 extern BOOL g_b_init_compare_string_w
;
72 extern BOOL g_b_init_debug_break_process
;
74 int sys_select (int, SELECT_TYPE
*, SELECT_TYPE
*, SELECT_TYPE
*,
75 const struct timespec
*, const sigset_t
*);
77 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
78 static signal_handler sig_handlers
[NSIG
];
80 static sigset_t sig_mask
;
82 static CRITICAL_SECTION crit_sig
;
84 /* Improve on the CRT 'signal' implementation so that we could record
85 the SIGCHLD handler and fake interval timers. */
87 sys_signal (int sig
, signal_handler handler
)
91 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
92 below. SIGALRM and SIGPROF are used by setitimer. All the
93 others are the only ones supported by the MS runtime. */
94 if (!(sig
== SIGINT
|| sig
== SIGSEGV
|| sig
== SIGILL
95 || sig
== SIGFPE
|| sig
== SIGABRT
|| sig
== SIGTERM
96 || sig
== SIGCHLD
|| sig
== SIGALRM
|| sig
== SIGPROF
))
101 old
= sig_handlers
[sig
];
102 /* SIGABRT is treated specially because w32.c installs term_ntproc
103 as its handler, so we don't want to override that afterwards.
104 Aborting Emacs works specially anyway: either by calling
105 emacs_abort directly or through terminate_due_to_signal, which
106 calls emacs_abort through emacs_raise. */
107 if (!(sig
== SIGABRT
&& old
== term_ntproc
))
109 sig_handlers
[sig
] = handler
;
110 if (!(sig
== SIGCHLD
|| sig
== SIGALRM
|| sig
== SIGPROF
))
111 signal (sig
, handler
);
116 /* Emulate sigaction. */
118 sigaction (int sig
, const struct sigaction
*act
, struct sigaction
*oact
)
120 signal_handler old
= SIG_DFL
;
124 old
= sys_signal (sig
, act
->sa_handler
);
126 old
= sig_handlers
[sig
];
135 oact
->sa_handler
= old
;
137 oact
->sa_mask
= empty_mask
;
142 /* Emulate signal sets and blocking of signals used by timers. */
145 sigemptyset (sigset_t
*set
)
152 sigaddset (sigset_t
*set
, int signo
)
159 if (signo
< 0 || signo
>= NSIG
)
165 *set
|= (1U << signo
);
171 sigfillset (sigset_t
*set
)
184 sigprocmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
186 if (!(how
== SIG_BLOCK
|| how
== SIG_UNBLOCK
|| how
== SIG_SETMASK
))
207 /* FIXME: Catch signals that are blocked and reissue them when
208 they are unblocked. Important for SIGALRM and SIGPROF only. */
217 pthread_sigmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
219 if (sigprocmask (how
, set
, oset
) == -1)
225 sigismember (const sigset_t
*set
, int signo
)
227 if (signo
< 0 || signo
>= NSIG
)
232 if (signo
> sizeof (*set
) * CHAR_BIT
)
235 return (*set
& (1U << signo
)) != 0;
251 setpgid (pid_t pid
, pid_t pgid
)
262 /* Emulations of interval timers.
264 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
266 Implementation: a separate thread is started for each timer type,
267 the thread calls the appropriate signal handler when the timer
268 expires, after stopping the thread which installed the timer. */
271 volatile ULONGLONG expire
;
272 volatile ULONGLONG reload
;
273 volatile int terminate
;
275 HANDLE caller_thread
;
279 static ULONGLONG ticks_now
;
280 static struct itimer_data real_itimer
, prof_itimer
;
281 static ULONGLONG clocks_min
;
282 /* If non-zero, itimers are disabled. Used during shutdown, when we
283 delete the critical sections used by the timer threads. */
284 static int disable_itimers
;
286 static CRITICAL_SECTION crit_real
, crit_prof
;
288 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
289 typedef BOOL (WINAPI
*GetThreadTimes_Proc
) (
291 LPFILETIME lpCreationTime
,
292 LPFILETIME lpExitTime
,
293 LPFILETIME lpKernelTime
,
294 LPFILETIME lpUserTime
);
296 static GetThreadTimes_Proc s_pfn_Get_Thread_Times
;
298 #define MAX_SINGLE_SLEEP 30
299 #define TIMER_TICKS_PER_SEC 1000
301 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
302 to a thread. If THREAD is NULL or an invalid handle, return the
303 current wall-clock time since January 1, 1601 (UTC). Otherwise,
304 return the sum of kernel and user times used by THREAD since it was
305 created, plus its creation time. */
307 w32_get_timer_time (HANDLE thread
)
310 int use_system_time
= 1;
311 /* The functions below return times in 100-ns units. */
312 const int tscale
= 10 * TIMER_TICKS_PER_SEC
;
314 if (thread
&& thread
!= INVALID_HANDLE_VALUE
315 && s_pfn_Get_Thread_Times
!= NULL
)
317 FILETIME creation_ftime
, exit_ftime
, kernel_ftime
, user_ftime
;
318 ULARGE_INTEGER temp_creation
, temp_kernel
, temp_user
;
320 if (s_pfn_Get_Thread_Times (thread
, &creation_ftime
, &exit_ftime
,
321 &kernel_ftime
, &user_ftime
))
324 temp_creation
.LowPart
= creation_ftime
.dwLowDateTime
;
325 temp_creation
.HighPart
= creation_ftime
.dwHighDateTime
;
326 temp_kernel
.LowPart
= kernel_ftime
.dwLowDateTime
;
327 temp_kernel
.HighPart
= kernel_ftime
.dwHighDateTime
;
328 temp_user
.LowPart
= user_ftime
.dwLowDateTime
;
329 temp_user
.HighPart
= user_ftime
.dwHighDateTime
;
331 temp_creation
.QuadPart
/ tscale
+ temp_kernel
.QuadPart
/ tscale
332 + temp_user
.QuadPart
/ tscale
;
335 DebPrint (("GetThreadTimes failed with error code %lu\n",
341 FILETIME current_ftime
;
344 GetSystemTimeAsFileTime (¤t_ftime
);
346 temp
.LowPart
= current_ftime
.dwLowDateTime
;
347 temp
.HighPart
= current_ftime
.dwHighDateTime
;
349 retval
= temp
.QuadPart
/ tscale
;
355 /* Thread function for a timer thread. */
357 timer_loop (LPVOID arg
)
359 struct itimer_data
*itimer
= (struct itimer_data
*)arg
;
360 int which
= itimer
->type
;
361 int sig
= (which
== ITIMER_REAL
) ? SIGALRM
: SIGPROF
;
362 CRITICAL_SECTION
*crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
363 const DWORD max_sleep
= MAX_SINGLE_SLEEP
* 1000 / TIMER_TICKS_PER_SEC
;
364 HANDLE hth
= (which
== ITIMER_REAL
) ? NULL
: itimer
->caller_thread
;
369 signal_handler handler
;
370 ULONGLONG now
, expire
, reload
;
372 /* Load new values if requested by setitimer. */
373 EnterCriticalSection (crit
);
374 expire
= itimer
->expire
;
375 reload
= itimer
->reload
;
376 LeaveCriticalSection (crit
);
377 if (itimer
->terminate
)
387 if (expire
> (now
= w32_get_timer_time (hth
)))
388 sleep_time
= expire
- now
;
391 /* Don't sleep too long at a time, to be able to see the
392 termination flag without too long a delay. */
393 while (sleep_time
> max_sleep
)
395 if (itimer
->terminate
)
398 EnterCriticalSection (crit
);
399 expire
= itimer
->expire
;
400 LeaveCriticalSection (crit
);
402 (expire
> (now
= w32_get_timer_time (hth
))) ? expire
- now
: 0;
404 if (itimer
->terminate
)
408 Sleep (sleep_time
* 1000 / TIMER_TICKS_PER_SEC
);
409 /* Always sleep past the expiration time, to make sure we
410 never call the handler _before_ the expiration time,
411 always slightly after it. Sleep(5) makes sure we don't
412 hog the CPU by calling 'w32_get_timer_time' with high
413 frequency, and also let other threads work. */
414 while (w32_get_timer_time (hth
) < expire
)
418 EnterCriticalSection (crit
);
419 expire
= itimer
->expire
;
420 LeaveCriticalSection (crit
);
425 handler
= sig_handlers
[sig
];
426 if (!(handler
== SIG_DFL
|| handler
== SIG_IGN
|| handler
== SIG_ERR
)
427 /* FIXME: Don't ignore masked signals. Instead, record that
428 they happened and reissue them when the signal is
430 && !sigismember (&sig_mask
, sig
)
431 /* Simulate masking of SIGALRM and SIGPROF when processing
433 && !fatal_error_in_progress
434 && itimer
->caller_thread
)
436 /* Simulate a signal delivered to the thread which installed
437 the timer, by suspending that thread while the handler
439 HANDLE th
= itimer
->caller_thread
;
440 DWORD result
= SuspendThread (th
);
442 if (result
== (DWORD
)-1)
449 /* Update expiration time and loop. */
450 EnterCriticalSection (crit
);
451 expire
= itimer
->expire
;
454 LeaveCriticalSection (crit
);
457 reload
= itimer
->reload
;
460 now
= w32_get_timer_time (hth
);
463 ULONGLONG lag
= now
- expire
;
465 /* If we missed some opportunities (presumably while
466 sleeping or while the signal handler ran), skip
469 expire
= now
- (lag
% reload
);
475 expire
= 0; /* become idle */
476 itimer
->expire
= expire
;
477 LeaveCriticalSection (crit
);
483 stop_timer_thread (int which
)
485 struct itimer_data
*itimer
=
486 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
488 DWORD err
, exit_code
= 255;
491 /* Signal the thread that it should terminate. */
492 itimer
->terminate
= 1;
494 if (itimer
->timer_thread
== NULL
)
497 /* Wait for the timer thread to terminate voluntarily, then kill it
498 if it doesn't. This loop waits twice more than the maximum
499 amount of time a timer thread sleeps, see above. */
500 for (i
= 0; i
< MAX_SINGLE_SLEEP
/ 5; i
++)
502 if (!((status
= GetExitCodeThread (itimer
->timer_thread
, &exit_code
))
503 && exit_code
== STILL_ACTIVE
))
507 if ((status
== FALSE
&& (err
= GetLastError ()) == ERROR_INVALID_HANDLE
)
508 || exit_code
== STILL_ACTIVE
)
510 if (!(status
== FALSE
&& err
== ERROR_INVALID_HANDLE
))
511 TerminateThread (itimer
->timer_thread
, 0);
515 CloseHandle (itimer
->timer_thread
);
516 itimer
->timer_thread
= NULL
;
517 if (itimer
->caller_thread
)
519 CloseHandle (itimer
->caller_thread
);
520 itimer
->caller_thread
= NULL
;
524 /* This is called at shutdown time from term_ntproc. */
528 if (real_itimer
.timer_thread
)
529 stop_timer_thread (ITIMER_REAL
);
530 if (prof_itimer
.timer_thread
)
531 stop_timer_thread (ITIMER_PROF
);
533 /* We are going to delete the critical sections, so timers cannot
537 DeleteCriticalSection (&crit_real
);
538 DeleteCriticalSection (&crit_prof
);
539 DeleteCriticalSection (&crit_sig
);
542 /* This is called at initialization time from init_ntproc. */
546 /* GetThreadTimes is not available on all versions of Windows, so
547 need to probe for its availability dynamically, and call it
548 through a pointer. */
549 s_pfn_Get_Thread_Times
= NULL
; /* in case dumped Emacs comes with a value */
550 if (os_subtype
!= OS_9X
)
551 s_pfn_Get_Thread_Times
=
552 (GetThreadTimes_Proc
)GetProcAddress (GetModuleHandle ("kernel32.dll"),
555 /* Make sure we start with zeroed out itimer structures, since
556 dumping may have left there traces of threads long dead. */
557 memset (&real_itimer
, 0, sizeof real_itimer
);
558 memset (&prof_itimer
, 0, sizeof prof_itimer
);
560 InitializeCriticalSection (&crit_real
);
561 InitializeCriticalSection (&crit_prof
);
562 InitializeCriticalSection (&crit_sig
);
568 start_timer_thread (int which
)
570 DWORD exit_code
, tid
;
572 struct itimer_data
*itimer
=
573 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
575 if (itimer
->timer_thread
576 && GetExitCodeThread (itimer
->timer_thread
, &exit_code
)
577 && exit_code
== STILL_ACTIVE
)
580 /* Clean up after possibly exited thread. */
581 if (itimer
->timer_thread
)
583 CloseHandle (itimer
->timer_thread
);
584 itimer
->timer_thread
= NULL
;
586 if (itimer
->caller_thread
)
588 CloseHandle (itimer
->caller_thread
);
589 itimer
->caller_thread
= NULL
;
592 /* Start a new thread. */
593 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
594 GetCurrentProcess (), &th
, 0, FALSE
,
595 DUPLICATE_SAME_ACCESS
))
600 itimer
->terminate
= 0;
601 itimer
->type
= which
;
602 itimer
->caller_thread
= th
;
603 /* Request that no more than 64KB of stack be reserved for this
604 thread, to avoid reserving too much memory, which would get in
605 the way of threads we start to wait for subprocesses. See also
607 itimer
->timer_thread
= CreateThread (NULL
, 64 * 1024, timer_loop
,
608 (void *)itimer
, 0x00010000, &tid
);
610 if (!itimer
->timer_thread
)
612 CloseHandle (itimer
->caller_thread
);
613 itimer
->caller_thread
= NULL
;
618 /* This is needed to make sure that the timer thread running for
619 profiling gets CPU as soon as the Sleep call terminates. */
620 if (which
== ITIMER_PROF
)
621 SetThreadPriority (itimer
->timer_thread
, THREAD_PRIORITY_TIME_CRITICAL
);
626 /* Most of the code of getitimer and setitimer (but not of their
627 subroutines) was shamelessly stolen from itimer.c in the DJGPP
628 library, see www.delorie.com/djgpp. */
630 getitimer (int which
, struct itimerval
*value
)
632 volatile ULONGLONG
*t_expire
;
633 volatile ULONGLONG
*t_reload
;
634 ULONGLONG expire
, reload
;
636 CRITICAL_SECTION
*crit
;
637 struct itimer_data
*itimer
;
648 if (which
!= ITIMER_REAL
&& which
!= ITIMER_PROF
)
654 itimer
= (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
656 ticks_now
= w32_get_timer_time ((which
== ITIMER_REAL
)
658 : GetCurrentThread ());
660 t_expire
= &itimer
->expire
;
661 t_reload
= &itimer
->reload
;
662 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
664 EnterCriticalSection (crit
);
667 LeaveCriticalSection (crit
);
672 value
->it_value
.tv_sec
= expire
/ TIMER_TICKS_PER_SEC
;
674 (expire
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
675 value
->it_value
.tv_usec
= usecs
;
676 value
->it_interval
.tv_sec
= reload
/ TIMER_TICKS_PER_SEC
;
678 (reload
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
679 value
->it_interval
.tv_usec
= usecs
;
685 setitimer(int which
, struct itimerval
*value
, struct itimerval
*ovalue
)
687 volatile ULONGLONG
*t_expire
, *t_reload
;
688 ULONGLONG expire
, reload
, expire_old
, reload_old
;
690 CRITICAL_SECTION
*crit
;
691 struct itimerval tem
, *ptem
;
696 /* Posix systems expect timer values smaller than the resolution of
697 the system clock be rounded up to the clock resolution. First
698 time we are called, measure the clock tick resolution. */
703 for (t1
= w32_get_timer_time (NULL
);
704 (t2
= w32_get_timer_time (NULL
)) == t1
; )
706 clocks_min
= t2
- t1
;
714 if (getitimer (which
, ptem
)) /* also sets ticks_now */
715 return -1; /* errno already set */
718 (which
== ITIMER_REAL
) ? &real_itimer
.expire
: &prof_itimer
.expire
;
720 (which
== ITIMER_REAL
) ? &real_itimer
.reload
: &prof_itimer
.reload
;
722 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
725 || (value
->it_value
.tv_sec
== 0 && value
->it_value
.tv_usec
== 0))
727 EnterCriticalSection (crit
);
728 /* Disable the timer. */
731 LeaveCriticalSection (crit
);
735 reload
= value
->it_interval
.tv_sec
* TIMER_TICKS_PER_SEC
;
737 usecs
= value
->it_interval
.tv_usec
;
738 if (value
->it_interval
.tv_sec
== 0
739 && usecs
&& usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
743 usecs
*= TIMER_TICKS_PER_SEC
;
744 reload
+= usecs
/ 1000000;
747 expire
= value
->it_value
.tv_sec
* TIMER_TICKS_PER_SEC
;
748 usecs
= value
->it_value
.tv_usec
;
749 if (value
->it_value
.tv_sec
== 0
750 && usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
754 usecs
*= TIMER_TICKS_PER_SEC
;
755 expire
+= usecs
/ 1000000;
760 EnterCriticalSection (crit
);
761 expire_old
= *t_expire
;
762 reload_old
= *t_reload
;
763 if (!(expire
== expire_old
&& reload
== reload_old
))
768 LeaveCriticalSection (crit
);
770 return start_timer_thread (which
);
776 #ifdef HAVE_SETITIMER
777 struct itimerval new_values
, old_values
;
779 new_values
.it_value
.tv_sec
= seconds
;
780 new_values
.it_value
.tv_usec
= 0;
781 new_values
.it_interval
.tv_sec
= new_values
.it_interval
.tv_usec
= 0;
783 if (setitimer (ITIMER_REAL
, &new_values
, &old_values
) < 0)
785 return old_values
.it_value
.tv_sec
;
793 /* Here's an overview of how support for subprocesses and
794 network/serial streams is implemented on MS-Windows.
796 The management of both subprocesses and network/serial streams
797 circles around the child_procs[] array, which can record up to the
798 grand total of MAX_CHILDREN (= 32) of these. (The reasons for the
799 32 limitation will become clear below.) Each member of
800 child_procs[] is a child_process structure, defined on w32.h.
802 A related data structure is the fd_info[] array, which holds twice
803 as many members, 64, and records the information about file
804 descriptors used for communicating with subprocesses and
805 network/serial devices. Each member of the array is the filedesc
806 structure, which records the Windows handle for communications,
807 such as the read end of the pipe to a subprocess, a socket handle,
810 Both these arrays reference each other: there's a member of
811 child_process structure that records the corresponding file
812 descriptor, and there's a member of filedesc structure that holds a
813 pointer to the corresponding child_process.
815 Whenever Emacs starts a subprocess or opens a network/serial
816 stream, the function new_child is called to prepare a new
817 child_process structure. new_child looks for the first vacant slot
818 in the child_procs[] array, initializes it, and starts a "reader
819 thread" that will watch the output of the subprocess/stream and its
820 status. (If no vacant slot can be found, new_child returns a
821 failure indication to its caller, and the higher-level Emacs
822 primitive that called it will then fail with EMFILE or EAGAIN.)
824 The reader thread started by new_child communicates with the main
825 (a.k.a. "Lisp") thread via two event objects and a status, all of
826 them recorded by the members of the child_process structure in
827 child_procs[]. The event objects serve as semaphores between the
828 reader thread and the 'pselect' emulation in sys_select, as follows:
830 . Initially, the reader thread is waiting for the char_consumed
831 event to become signaled by sys_select, which is an indication
832 for the reader thread to go ahead and try reading more stuff
833 from the subprocess/stream.
835 . The reader thread then attempts to read by calling a
836 blocking-read function. When the read call returns, either
837 successfully or with some failure indication, the reader thread
838 updates the status of the read accordingly, and signals the 2nd
839 event object, char_avail, on whose handle sys_select is
840 waiting. This tells sys_select that the file descriptor
841 allocated for the subprocess or the the stream is ready to be
844 When the subprocess exits or the network/serial stream is closed,
845 the reader thread sets the status accordingly and exits. It also
846 exits when the main thread sets the status to STATUS_READ_ERROR
847 and/or the char_avail and char_consumed event handles become NULL;
848 this is how delete_child, called by Emacs when a subprocess or a
849 stream is terminated, terminates the reader thread as part of
850 deleting the child_process object.
852 The sys_select function emulates the Posix 'pselect' functionality;
853 it is needed because the Windows 'select' function supports only
854 network sockets, while Emacs expects 'pselect' to work for any file
855 descriptor, including pipes and serial streams.
857 When sys_select is called, it uses the information in fd_info[]
858 array to convert the file descriptors which it was asked to watch
859 into Windows handles. In general, the handle to watch is the
860 handle of the char_avail event of the child_process structure that
861 corresponds to the file descriptor. In addition, for subprocesses,
862 sys_select watches one more handle: the handle for the subprocess,
863 so that it could emulate the SIGCHLD signal when the subprocess
866 If file descriptor zero (stdin) doesn't have its bit set in the
867 'rfds' argument to sys_select, the function always watches for
868 keyboard interrupts, to be able to interrupt the wait and return
869 when the user presses C-g.
871 Having collected the handles to watch, sys_select calls
872 WaitForMultipleObjects to wait for any one of them to become
873 signaled. Since WaitForMultipleObjects can only watch up to 64
874 handles, Emacs on Windows is limited to maximum 32 child_process
875 objects (since a subprocess consumes 2 handles to be watched, see
878 When any of the handles become signaled, sys_select does whatever
879 is appropriate for the corresponding child_process object:
881 . If it's a handle to the char_avail event, sys_select marks the
882 corresponding bit in 'rfds', and Emacs will then read from that
885 . If it's a handle to the process, sys_select calls the SIGCHLD
886 handler, to inform Emacs of the fact that the subprocess
889 The waitpid emulation works very similar to sys_select, except that
890 it only watches handles of subprocesses, and doesn't synchronize
891 with the reader thread.
893 Because socket descriptors on Windows are handles, while Emacs
894 expects them to be file descriptors, all low-level I/O functions,
895 such as 'read' and 'write', and all socket operations, like
896 'connect', 'recvfrom', 'accept', etc., are redirected to the
897 corresponding 'sys_*' functions, which must convert a file
898 descriptor to a handle using the fd_info[] array, and then invoke
899 the corresponding Windows API on the handle. Most of these
900 redirected 'sys_*' functions are implemented on w32.c.
902 When the file descriptor was produced by functions such as 'open',
903 the corresponding handle is obtained by calling _get_osfhandle. To
904 produce a file descriptor for a socket handle, which has no file
905 descriptor as far as Windows is concerned, the function
906 socket_to_fd opens the null device; the resulting file descriptor
907 will never be used directly in any I/O API, but serves as an index
908 into the fd_info[] array, where the socket handle is stored. The
909 SOCK_HANDLE macro retrieves the handle when given the file
912 The function sys_kill emulates the Posix 'kill' functionality to
913 terminate other processes. It does that by attaching to the
914 foreground window of the process and sending a Ctrl-C or Ctrl-BREAK
915 signal to the process; if that doesn't work, then it calls
916 TerminateProcess to forcibly terminate the process. Note that this
917 only terminates the immediate process whose PID was passed to
918 sys_kill; it doesn't terminate the child processes of that process.
919 This means, for example, that an Emacs subprocess run through a
920 shell might not be killed, because sys_kill will only terminate the
921 shell. (In practice, however, such problems are very rare.) */
923 /* Defined in <process.h> which conflicts with the local copy */
926 /* Child process management list. */
927 int child_proc_count
= 0;
928 child_process child_procs
[ MAX_CHILDREN
];
930 static DWORD WINAPI
reader_thread (void *arg
);
932 /* Find an unused process slot. */
939 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
940 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
942 if (child_proc_count
== MAX_CHILDREN
)
945 child_process
*dead_cp
= NULL
;
947 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
948 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
949 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
)
953 if (!GetExitCodeProcess (cp
->procinfo
.hProcess
, &status
))
955 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
956 GetLastError (), cp
->procinfo
.dwProcessId
));
957 status
= STILL_ACTIVE
;
959 if (status
!= STILL_ACTIVE
960 || WaitForSingleObject (cp
->procinfo
.hProcess
, 0) == WAIT_OBJECT_0
)
962 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
963 cp
->procinfo
.dwProcessId
, cp
->fd
));
964 CloseHandle (cp
->procinfo
.hProcess
);
965 cp
->procinfo
.hProcess
= NULL
;
966 CloseHandle (cp
->procinfo
.hThread
);
967 cp
->procinfo
.hThread
= NULL
;
968 /* Free up to 2 dead slots at a time, so that if we
969 have a lot of them, they will eventually all be
970 freed when the tornado ends. */
984 if (child_proc_count
== MAX_CHILDREN
)
986 cp
= &child_procs
[child_proc_count
++];
989 /* Last opportunity to avoid leaking handles before we forget them
991 if (cp
->procinfo
.hProcess
)
992 CloseHandle (cp
->procinfo
.hProcess
);
993 if (cp
->procinfo
.hThread
)
994 CloseHandle (cp
->procinfo
.hThread
);
995 memset (cp
, 0, sizeof (*cp
));
998 cp
->procinfo
.hProcess
= NULL
;
999 cp
->status
= STATUS_READ_ERROR
;
1001 /* use manual reset event so that select() will function properly */
1002 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
1005 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
1006 if (cp
->char_consumed
)
1008 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
1009 It means that the 64K stack we are requesting in the 2nd
1010 argument is how much memory should be reserved for the
1011 stack. If we don't use this flag, the memory requested
1012 by the 2nd argument is the amount actually _committed_,
1013 but Windows reserves 8MB of memory for each thread's
1014 stack. (The 8MB figure comes from the -stack
1015 command-line argument we pass to the linker when building
1016 Emacs, but that's because we need a large stack for
1017 Emacs's main thread.) Since we request 2GB of reserved
1018 memory at startup (see w32heap.c), which is close to the
1019 maximum memory available for a 32-bit process on Windows,
1020 the 8MB reservation for each thread causes failures in
1021 starting subprocesses, because we create a thread running
1022 reader_thread for each subprocess. As 8MB of stack is
1023 way too much for reader_thread, forcing Windows to
1024 reserve less wins the day. */
1025 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
1036 delete_child (child_process
*cp
)
1040 /* Should not be deleting a child that is still needed. */
1041 for (i
= 0; i
< MAXDESC
; i
++)
1042 if (fd_info
[i
].cp
== cp
)
1045 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
1048 /* reap thread if necessary */
1053 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
1055 /* let the thread exit cleanly if possible */
1056 cp
->status
= STATUS_READ_ERROR
;
1057 SetEvent (cp
->char_consumed
);
1059 /* We used to forcibly terminate the thread here, but it
1060 is normally unnecessary, and in abnormal cases, the worst that
1061 will happen is we have an extra idle thread hanging around
1062 waiting for the zombie process. */
1063 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
1065 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
1066 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
1067 TerminateThread (cp
->thrd
, 0);
1071 CloseHandle (cp
->thrd
);
1076 CloseHandle (cp
->char_avail
);
1077 cp
->char_avail
= NULL
;
1079 if (cp
->char_consumed
)
1081 CloseHandle (cp
->char_consumed
);
1082 cp
->char_consumed
= NULL
;
1085 /* update child_proc_count (highest numbered slot in use plus one) */
1086 if (cp
== child_procs
+ child_proc_count
- 1)
1088 for (i
= child_proc_count
-1; i
>= 0; i
--)
1089 if (CHILD_ACTIVE (&child_procs
[i
])
1090 || child_procs
[i
].procinfo
.hProcess
!= NULL
)
1092 child_proc_count
= i
+ 1;
1097 child_proc_count
= 0;
1100 /* Find a child by pid. */
1101 static child_process
*
1102 find_child_pid (DWORD pid
)
1106 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1107 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
!= NULL
)
1114 release_listen_threads (void)
1118 for (i
= child_proc_count
- 1; i
>= 0; i
--)
1120 if (CHILD_ACTIVE (&child_procs
[i
])
1121 && (fd_info
[child_procs
[i
].fd
].flags
& FILE_LISTEN
))
1122 child_procs
[i
].status
= STATUS_READ_ERROR
;
1126 /* Thread proc for child process and socket reader threads. Each thread
1127 is normally blocked until woken by select() to check for input by
1128 reading one char. When the read completes, char_avail is signaled
1129 to wake up the select emulator and the thread blocks itself again. */
1131 reader_thread (void *arg
)
1136 cp
= (child_process
*)arg
;
1138 /* We have to wait for the go-ahead before we can start */
1140 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
1148 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_CONNECT
) != 0)
1149 rc
= _sys_wait_connect (cp
->fd
);
1150 else if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_LISTEN
) != 0)
1151 rc
= _sys_wait_accept (cp
->fd
);
1153 rc
= _sys_read_ahead (cp
->fd
);
1155 /* Don't bother waiting for the event if we already have been
1156 told to exit by delete_child. */
1157 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_avail
)
1160 /* The name char_avail is a misnomer - it really just means the
1161 read-ahead has completed, whether successfully or not. */
1162 if (!SetEvent (cp
->char_avail
))
1164 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1165 (DWORD_PTR
)cp
->char_avail
, GetLastError (),
1170 if (rc
== STATUS_READ_ERROR
|| rc
== STATUS_CONNECT_FAILED
)
1173 /* If the read died, the child has died so let the thread die */
1174 if (rc
== STATUS_READ_FAILED
)
1177 /* Don't bother waiting for the acknowledge if we already have
1178 been told to exit by delete_child. */
1179 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_consumed
)
1182 /* Wait until our input is acknowledged before reading again */
1183 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
1185 DebPrint (("reader_thread.WaitForSingleObject failed with "
1186 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
1189 /* delete_child sets status to STATUS_READ_ERROR when it wants
1191 if (cp
->status
== STATUS_READ_ERROR
)
1197 /* To avoid Emacs changing directory, we just record here the
1198 directory the new process should start in. This is set just before
1199 calling sys_spawnve, and is not generally valid at any other time.
1200 Note that this directory's name is UTF-8 encoded. */
1201 static char * process_dir
;
1204 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
1205 pid_t
* pPid
, child_process
*cp
)
1208 SECURITY_ATTRIBUTES sec_attrs
;
1210 SECURITY_DESCRIPTOR sec_desc
;
1213 char dir
[ MAX_PATH
];
1217 if (cp
== NULL
) emacs_abort ();
1219 memset (&start
, 0, sizeof (start
));
1220 start
.cb
= sizeof (start
);
1223 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1224 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1226 start
.dwFlags
= STARTF_USESTDHANDLES
;
1227 start
.wShowWindow
= SW_HIDE
;
1229 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1230 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1231 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1232 #endif /* HAVE_NTGUI */
1235 /* Explicitly specify no security */
1236 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1238 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1241 sec_attrs
.nLength
= sizeof (sec_attrs
);
1242 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1243 sec_attrs
.bInheritHandle
= FALSE
;
1245 filename_to_ansi (process_dir
, dir
);
1246 /* Can't use unixtodos_filename here, since that needs its file name
1247 argument encoded in UTF-8. OTOH, process_dir, which _is_ in
1248 UTF-8, points, to the directory computed by our caller, and we
1249 don't want to modify that, either. */
1250 for (p
= dir
; *p
; p
= CharNextA (p
))
1254 /* CreateProcess handles batch files as exe specially. This special
1255 handling fails when both the batch file and arguments are quoted.
1256 We pass NULL as exe to avoid the special handling. */
1257 if (exe
&& cmdline
[0] == '"' &&
1258 (ext
= strrchr (exe
, '.')) &&
1259 (xstrcasecmp (ext
, ".bat") == 0
1260 || xstrcasecmp (ext
, ".cmd") == 0))
1263 flags
= (!NILP (Vw32_start_process_share_console
)
1264 ? CREATE_NEW_PROCESS_GROUP
1265 : CREATE_NEW_CONSOLE
);
1266 if (NILP (Vw32_start_process_inherit_error_mode
))
1267 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1268 if (!CreateProcessA (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1269 flags
, env
, dir
, &start
, &cp
->procinfo
))
1272 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1274 /* Hack for Windows 95, which assigns large (ie negative) pids */
1283 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1287 /* create_child doesn't know what emacs's file handle will be for waiting
1288 on output from the child, so we need to make this additional call
1289 to register the handle with the process
1290 This way the select emulator knows how to match file handles with
1291 entries in child_procs. */
1293 register_child (pid_t pid
, int fd
)
1297 cp
= find_child_pid ((DWORD
)pid
);
1300 DebPrint (("register_child unable to find pid %lu\n", pid
));
1305 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1310 /* thread is initially blocked until select is called; set status so
1311 that select will release thread */
1312 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1314 /* attach child_process to fd_info */
1315 if (fd_info
[fd
].cp
!= NULL
)
1317 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1321 fd_info
[fd
].cp
= cp
;
1324 /* Called from waitpid when a process exits. */
1326 reap_subprocess (child_process
*cp
)
1328 if (cp
->procinfo
.hProcess
)
1330 /* Reap the process */
1332 /* Process should have already died before we are called. */
1333 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1334 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp
->fd
));
1336 CloseHandle (cp
->procinfo
.hProcess
);
1337 cp
->procinfo
.hProcess
= NULL
;
1338 CloseHandle (cp
->procinfo
.hThread
);
1339 cp
->procinfo
.hThread
= NULL
;
1342 /* If cp->fd was not closed yet, we might be still reading the
1343 process output, so don't free its resources just yet. The call
1344 to delete_child on behalf of this subprocess will be made by
1345 sys_read when the subprocess output is fully read. */
1350 /* Wait for a child process specified by PID, or for any of our
1351 existing child processes (if PID is nonpositive) to die. When it
1352 does, close its handle. Return the pid of the process that died
1353 and fill in STATUS if non-NULL. */
1356 waitpid (pid_t pid
, int *status
, int options
)
1358 DWORD active
, retval
;
1360 child_process
*cp
, *cps
[MAX_CHILDREN
];
1361 HANDLE wait_hnd
[MAX_CHILDREN
];
1363 int dont_wait
= (options
& WNOHANG
) != 0;
1366 /* According to Posix:
1368 PID = -1 means status is requested for any child process.
1370 PID > 0 means status is requested for a single child process
1373 PID = 0 means status is requested for any child process whose
1374 process group ID is equal to that of the calling process. But
1375 since Windows has only a limited support for process groups (only
1376 for console processes and only for the purposes of passing
1377 Ctrl-BREAK signal to them), and since we have no documented way
1378 of determining whether a given process belongs to our group, we
1381 PID < -1 means status is requested for any child process whose
1382 process group ID is equal to the absolute value of PID. Again,
1383 since we don't support process groups, we treat that as -1. */
1388 /* We are requested to wait for a specific child. */
1389 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1391 /* Some child_procs might be sockets; ignore them. Also
1392 ignore subprocesses whose output is not yet completely
1394 if (CHILD_ACTIVE (cp
)
1395 && cp
->procinfo
.hProcess
1404 if (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1406 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1412 /* PID specifies our subprocess, but its status is not
1419 /* No such child process, or nothing to wait for, so fail. */
1426 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1428 if (CHILD_ACTIVE (cp
)
1429 && cp
->procinfo
.hProcess
1430 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1432 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1439 /* Nothing to wait on, so fail. */
1448 timeout_ms
= 1000; /* check for quit about once a second. */
1453 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, timeout_ms
);
1454 } while (active
== WAIT_TIMEOUT
&& !dont_wait
);
1456 if (active
== WAIT_FAILED
)
1461 else if (active
== WAIT_TIMEOUT
&& dont_wait
)
1463 /* PID specifies our subprocess, but it didn't exit yet, so its
1464 status is not yet available. */
1466 DebPrint (("Wait: PID %d not reap yet\n", cp
->pid
));
1470 else if (active
>= WAIT_OBJECT_0
1471 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1473 active
-= WAIT_OBJECT_0
;
1475 else if (active
>= WAIT_ABANDONED_0
1476 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1478 active
-= WAIT_ABANDONED_0
;
1483 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1485 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1489 if (retval
== STILL_ACTIVE
)
1491 /* Should never happen. */
1492 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1493 if (pid
> 0 && dont_wait
)
1499 /* Massage the exit code from the process to match the format expected
1500 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1501 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1503 if (retval
== STATUS_CONTROL_C_EXIT
)
1508 if (pid
> 0 && active
!= 0)
1513 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1518 reap_subprocess (cp
);
1523 /* Old versions of w32api headers don't have separate 32-bit and
1524 64-bit defines, but the one they have matches the 32-bit variety. */
1525 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1526 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1527 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1530 /* Implementation note: This function works with file names encoded in
1531 the current ANSI codepage. */
1533 w32_executable_type (char * filename
,
1535 int * is_cygnus_app
,
1539 file_data executable
;
1543 /* Default values in case we can't tell for sure. */
1544 *is_dos_app
= FALSE
;
1545 *is_cygnus_app
= FALSE
;
1546 *is_msys_app
= FALSE
;
1547 *is_gui_app
= FALSE
;
1549 if (!open_input_file (&executable
, filename
))
1552 p
= strrchr (filename
, '.');
1554 /* We can only identify DOS .com programs from the extension. */
1555 if (p
&& xstrcasecmp (p
, ".com") == 0)
1557 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1558 || xstrcasecmp (p
, ".cmd") == 0))
1560 /* A DOS shell script - it appears that CreateProcess is happy to
1561 accept this (somewhat surprisingly); presumably it looks at
1562 COMSPEC to determine what executable to actually invoke.
1563 Therefore, we have to do the same here as well. */
1564 /* Actually, I think it uses the program association for that
1565 extension, which is defined in the registry. */
1566 p
= egetenv ("COMSPEC");
1568 retval
= w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_msys_app
,
1573 /* Look for DOS .exe signature - if found, we must also check that
1574 it isn't really a 16- or 32-bit Windows exe, since both formats
1575 start with a DOS program stub. Note that 16-bit Windows
1576 executables use the OS/2 1.x format. */
1578 IMAGE_DOS_HEADER
* dos_header
;
1579 IMAGE_NT_HEADERS
* nt_header
;
1581 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1582 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1585 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1587 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1589 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1592 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1593 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1597 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1599 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1600 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1602 /* Ensure we are using the 32 bit structure. */
1603 IMAGE_OPTIONAL_HEADER32
*opt
1604 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1605 data_dir
= opt
->DataDirectory
;
1606 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1608 /* MingW 3.12 has the required 64 bit structs, but in case older
1609 versions don't, only check 64 bit exes if we know how. */
1610 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1611 else if (nt_header
->OptionalHeader
.Magic
1612 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1614 IMAGE_OPTIONAL_HEADER64
*opt
1615 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1616 data_dir
= opt
->DataDirectory
;
1617 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1622 /* Look for Cygwin DLL in the DLL import list. */
1623 IMAGE_DATA_DIRECTORY import_dir
=
1624 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1626 /* Import directory can be missing in .NET DLLs. */
1627 if (import_dir
.VirtualAddress
!= 0)
1629 IMAGE_IMPORT_DESCRIPTOR
* imports
=
1630 RVA_TO_PTR (import_dir
.VirtualAddress
,
1631 rva_to_section (import_dir
.VirtualAddress
,
1635 for ( ; imports
->Name
; imports
++)
1637 IMAGE_SECTION_HEADER
* section
=
1638 rva_to_section (imports
->Name
, nt_header
);
1639 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1642 /* The exact name of the Cygwin DLL has changed with
1643 various releases, but hopefully this will be
1644 reasonably future-proof. */
1645 if (strncmp (dllname
, "cygwin", 6) == 0)
1647 *is_cygnus_app
= TRUE
;
1650 else if (strncmp (dllname
, "msys-", 5) == 0)
1652 /* This catches both MSYS 1.x and MSYS2
1653 executables (the DLL name is msys-1.0.dll and
1654 msys-2.0.dll, respectively). There doesn't
1655 seem to be a reason to distinguish between
1656 the two, for now. */
1657 *is_msys_app
= TRUE
;
1667 close_file_data (&executable
);
1672 compare_env (const void *strp1
, const void *strp2
)
1674 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1676 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1678 /* Sort order in command.com/cmd.exe is based on uppercasing
1679 names, so do the same here. */
1680 if (toupper (*str1
) > toupper (*str2
))
1682 else if (toupper (*str1
) < toupper (*str2
))
1687 if (*str1
== '=' && *str2
== '=')
1689 else if (*str1
== '=')
1696 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1698 char **optr
, **nptr
;
1710 num
+= optr
- envp2
;
1712 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1717 /* When a new child process is created we need to register it in our list,
1718 so intercept spawn requests. */
1720 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1722 Lisp_Object program
, full
;
1723 char *cmdline
, *env
, *parg
, **targ
;
1727 int is_dos_app
, is_cygnus_app
, is_msys_app
, is_gui_app
;
1729 /* We pass our process ID to our children by setting up an environment
1730 variable in their environment. */
1731 char ppid_env_var_buffer
[64];
1732 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1733 /* These are the characters that cause an argument to need quoting.
1734 Arguments with whitespace characters need quoting to prevent the
1735 argument being split into two or more. Arguments with wildcards
1736 are also quoted, for consistency with posix platforms, where wildcards
1737 are not expanded if we run the program directly without a shell.
1738 Some extra whitespace characters need quoting in Cygwin/MSYS programs,
1739 so this list is conditionally modified below. */
1740 const char *sepchars
= " \t*?";
1741 /* This is for native w32 apps; modified below for Cygwin/MSUS apps. */
1742 char escape_char
= '\\';
1743 char cmdname_a
[MAX_PATH
];
1745 /* We don't care about the other modes */
1746 if (mode
!= _P_NOWAIT
)
1752 /* Handle executable names without an executable suffix. The caller
1753 already searched exec-path and verified the file is executable,
1754 but start-process doesn't do that for file names that are already
1755 absolute. So we double-check this here, just in case. */
1756 if (faccessat (AT_FDCWD
, cmdname
, X_OK
, AT_EACCESS
) != 0)
1758 program
= build_string (cmdname
);
1760 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
), 0);
1766 program
= ENCODE_FILE (full
);
1767 cmdname
= SSDATA (program
);
1771 char *p
= alloca (strlen (cmdname
) + 1);
1773 /* Don't change the command name we were passed by our caller
1774 (unixtodos_filename below will destructively mirror forward
1776 cmdname
= strcpy (p
, cmdname
);
1779 /* make sure argv[0] and cmdname are both in DOS format */
1780 unixtodos_filename (cmdname
);
1781 /* argv[0] was encoded by caller using ENCODE_FILE, so it is in
1782 UTF-8. All the other arguments are encoded by ENCODE_SYSTEM or
1783 some such, and are in some ANSI codepage. We need to have
1784 argv[0] encoded in ANSI codepage. */
1785 filename_to_ansi (cmdname
, cmdname_a
);
1786 /* We explicitly require that the command's file name be encodable
1787 in the current ANSI codepage, because we will be invoking it via
1789 if (_mbspbrk ((unsigned char *)cmdname_a
, (const unsigned char *)"?"))
1794 /* From here on, CMDNAME is an ANSI-encoded string. */
1795 cmdname
= cmdname_a
;
1798 /* Determine whether program is a 16-bit DOS executable, or a 32-bit
1799 Windows executable that is implicitly linked to the Cygnus or
1800 MSYS dll (implying it was compiled with the Cygnus/MSYS GNU
1801 toolchain and hence relies on cygwin.dll or MSYS DLL to parse the
1802 command line - we use this to decide how to escape quote chars in
1803 command line args that must be quoted).
1805 Also determine whether it is a GUI app, so that we don't hide its
1806 initial window unless specifically requested. */
1807 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_msys_app
,
1810 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1811 application to start it by specifying the helper app as cmdname,
1812 while leaving the real app name as argv[0]. */
1817 cmdname
= alloca (MAX_PATH
);
1818 if (egetenv ("CMDPROXY"))
1820 /* Implementation note: since process-environment, where
1821 'egetenv' looks, is encoded in the system codepage, we
1822 don't need to encode the cmdproxy file name if we get it
1823 from the environment. */
1824 strcpy (cmdname
, egetenv ("CMDPROXY"));
1828 char *q
= lispstpcpy (cmdname
,
1829 /* exec-directory needs to be encoded. */
1830 ansi_encode_filename (Vexec_directory
));
1831 /* If we are run from the source tree, use cmdproxy.exe from
1832 the same source tree. */
1833 for (p
= q
- 2; p
> cmdname
; p
= CharPrevA (cmdname
, p
))
1836 if (*p
== '/' && xstrcasecmp (p
, "/lib-src/") == 0)
1837 q
= stpcpy (p
, "/nt/");
1838 strcpy (q
, "cmdproxy.exe");
1841 /* Can't use unixtodos_filename here, since that needs its file
1842 name argument encoded in UTF-8. */
1843 for (p
= cmdname
; *p
; p
= CharNextA (p
))
1848 /* we have to do some conjuring here to put argv and envp into the
1849 form CreateProcess wants... argv needs to be a space separated/null
1850 terminated list of parameters, and envp is a null
1851 separated/double-null terminated list of parameters.
1853 Additionally, zero-length args and args containing whitespace or
1854 quote chars need to be wrapped in double quotes - for this to work,
1855 embedded quotes need to be escaped as well. The aim is to ensure
1856 the child process reconstructs the argv array we start with
1857 exactly, so we treat quotes at the beginning and end of arguments
1860 The w32 GNU-based library from Cygnus doubles quotes to escape
1861 them, while MSVC uses backslash for escaping. (Actually the MSVC
1862 startup code does attempt to recognize doubled quotes and accept
1863 them, but gets it wrong and ends up requiring three quotes to get a
1864 single embedded quote!) So by default we decide whether to use
1865 quote or backslash as the escape character based on whether the
1866 binary is apparently a Cygnus compiled app.
1868 Note that using backslash to escape embedded quotes requires
1869 additional special handling if an embedded quote is already
1870 preceded by backslash, or if an arg requiring quoting ends with
1871 backslash. In such cases, the run of escape characters needs to be
1872 doubled. For consistency, we apply this special handling as long
1873 as the escape character is not quote.
1875 Since we have no idea how large argv and envp are likely to be we
1876 figure out list lengths on the fly and allocate them. */
1878 if (!NILP (Vw32_quote_process_args
))
1881 /* Override escape char by binding w32-quote-process-args to
1882 desired character, or use t for auto-selection. */
1883 if (INTEGERP (Vw32_quote_process_args
))
1884 escape_char
= XINT (Vw32_quote_process_args
);
1886 escape_char
= (is_cygnus_app
|| is_msys_app
) ? '"' : '\\';
1889 /* Cygwin/MSYS apps need quoting a bit more often. */
1890 if (escape_char
== '"')
1891 sepchars
= "\r\n\t\f '";
1899 int need_quotes
= 0;
1900 int escape_char_run
= 0;
1906 if (escape_char
== '"' && *p
== '\\')
1907 /* If it's a Cygwin/MSYS app, \ needs to be escaped. */
1911 /* allow for embedded quotes to be escaped */
1914 /* handle the case where the embedded quote is already escaped */
1915 if (escape_char_run
> 0)
1917 /* To preserve the arg exactly, we need to double the
1918 preceding escape characters (plus adding one to
1919 escape the quote character itself). */
1920 arglen
+= escape_char_run
;
1923 else if (strchr (sepchars
, *p
) != NULL
)
1928 if (*p
== escape_char
&& escape_char
!= '"')
1931 escape_char_run
= 0;
1936 /* handle the case where the arg ends with an escape char - we
1937 must not let the enclosing quote be escaped. */
1938 if (escape_char_run
> 0)
1939 arglen
+= escape_char_run
;
1941 arglen
+= strlen (*targ
++) + 1;
1943 cmdline
= alloca (arglen
);
1949 int need_quotes
= 0;
1957 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1962 int escape_char_run
= 0;
1968 /* last = p + strlen (p) - 1; */
1971 /* This version does not escape quotes if they occur at the
1972 beginning or end of the arg - this could lead to incorrect
1973 behavior when the arg itself represents a command line
1974 containing quoted args. I believe this was originally done
1975 as a hack to make some things work, before
1976 `w32-quote-process-args' was added. */
1979 if (*p
== '"' && p
> first
&& p
< last
)
1980 *parg
++ = escape_char
; /* escape embedded quotes */
1988 /* double preceding escape chars if any */
1989 while (escape_char_run
> 0)
1991 *parg
++ = escape_char
;
1994 /* escape all quote chars, even at beginning or end */
1995 *parg
++ = escape_char
;
1997 else if (escape_char
== '"' && *p
== '\\')
2001 if (*p
== escape_char
&& escape_char
!= '"')
2004 escape_char_run
= 0;
2006 /* double escape chars before enclosing quote */
2007 while (escape_char_run
> 0)
2009 *parg
++ = escape_char
;
2017 strcpy (parg
, *targ
);
2018 parg
+= strlen (*targ
);
2028 numenv
= 1; /* for end null */
2031 arglen
+= strlen (*targ
++) + 1;
2034 /* extra env vars... */
2035 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
2036 GetCurrentProcessId ());
2037 arglen
+= strlen (ppid_env_var_buffer
) + 1;
2040 /* merge env passed in and extra env into one, and sort it. */
2041 targ
= (char **) alloca (numenv
* sizeof (char *));
2042 merge_and_sort_env (envp
, extra_env
, targ
);
2044 /* concatenate env entries. */
2045 env
= alloca (arglen
);
2049 strcpy (parg
, *targ
);
2050 parg
+= strlen (*targ
++);
2063 /* Now create the process. */
2064 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
2074 /* Emulate the select call.
2075 Wait for available input on any of the given rfds, or timeout if
2076 a timeout is given and no input is detected. wfds are supported
2077 only for asynchronous 'connect' calls. efds are not supported
2080 For simplicity, we detect the death of child processes here and
2081 synchronously call the SIGCHLD handler. Since it is possible for
2082 children to be created without a corresponding pipe handle from which
2083 to read output, we wait separately on the process handles as well as
2084 the char_avail events for each process pipe. We only call
2085 wait/reap_process when the process actually terminates.
2087 To reduce the number of places in which Emacs can be hung such that
2088 C-g is not able to interrupt it, we always wait on interrupt_handle
2089 (which is signaled by the input thread when C-g is detected). If we
2090 detect that we were woken up by C-g, we return -1 with errno set to
2091 EINTR as on Unix. */
2093 /* From w32console.c */
2094 extern HANDLE keyboard_handle
;
2096 /* From w32xfns.c */
2097 extern HANDLE interrupt_handle
;
2099 /* From process.c */
2100 extern int proc_buffered_char
[];
2103 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
2104 const struct timespec
*timeout
, const sigset_t
*ignored
)
2106 SELECT_TYPE orfds
, owfds
;
2107 DWORD timeout_ms
, start_time
;
2110 child_process
*cp
, *cps
[MAX_CHILDREN
];
2111 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
2112 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
2115 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
2117 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
2118 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
2124 /* Otherwise, we only handle rfds and wfds, so fail otherwise. */
2125 if ((rfds
== NULL
&& wfds
== NULL
) || efds
!= NULL
)
2147 /* If interrupt_handle is available and valid, always wait on it, to
2148 detect C-g (quit). */
2150 if (interrupt_handle
&& interrupt_handle
!= INVALID_HANDLE_VALUE
)
2152 wait_hnd
[0] = interrupt_handle
;
2157 /* Build a list of pipe handles to wait on. */
2158 for (i
= 0; i
< nfds
; i
++)
2159 if (FD_ISSET (i
, &orfds
) || FD_ISSET (i
, &owfds
))
2163 if (keyboard_handle
)
2165 /* Handle stdin specially */
2166 wait_hnd
[nh
] = keyboard_handle
;
2171 /* Check for any emacs-generated input in the queue since
2172 it won't be detected in the wait */
2173 if (rfds
&& detect_input_pending ())
2178 else if (noninteractive
)
2180 if (handle_file_notifications (NULL
))
2186 /* Child process and socket/comm port input. */
2188 if (FD_ISSET (i
, &owfds
)
2190 && (fd_info
[i
].flags
& FILE_CONNECT
) == 0)
2192 DebPrint (("sys_select: fd %d is in wfds, but FILE_CONNECT is reset!\n", i
));
2197 int current_status
= cp
->status
;
2199 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
2201 /* Tell reader thread which file handle to use. */
2203 /* Zero out the error code. */
2205 /* Wake up the reader thread for this process */
2206 cp
->status
= STATUS_READ_READY
;
2207 if (!SetEvent (cp
->char_consumed
))
2208 DebPrint (("sys_select.SetEvent failed with "
2209 "%lu for fd %ld\n", GetLastError (), i
));
2212 #ifdef CHECK_INTERLOCK
2213 /* slightly crude cross-checking of interlock between threads */
2215 current_status
= cp
->status
;
2216 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
2218 /* char_avail has been signaled, so status (which may
2219 have changed) should indicate read has completed
2220 but has not been acknowledged. */
2221 current_status
= cp
->status
;
2222 if (current_status
!= STATUS_READ_SUCCEEDED
2223 && current_status
!= STATUS_READ_FAILED
)
2224 DebPrint (("char_avail set, but read not completed: status %d\n",
2229 /* char_avail has not been signaled, so status should
2230 indicate that read is in progress; small possibility
2231 that read has completed but event wasn't yet signaled
2232 when we tested it (because a context switch occurred
2233 or if running on separate CPUs). */
2234 if (current_status
!= STATUS_READ_READY
2235 && current_status
!= STATUS_READ_IN_PROGRESS
2236 && current_status
!= STATUS_READ_SUCCEEDED
2237 && current_status
!= STATUS_READ_FAILED
)
2238 DebPrint (("char_avail reset, but read status is bad: %d\n",
2242 wait_hnd
[nh
] = cp
->char_avail
;
2244 if (!wait_hnd
[nh
]) emacs_abort ();
2247 DebPrint (("select waiting on child %d fd %d\n",
2248 cp
-child_procs
, i
));
2253 /* Unable to find something to wait on for this fd, skip */
2255 /* Note that this is not a fatal error, and can in fact
2256 happen in unusual circumstances. Specifically, if
2257 sys_spawnve fails, eg. because the program doesn't
2258 exist, and debug-on-error is t so Fsignal invokes a
2259 nested input loop, then the process output pipe is
2260 still included in input_wait_mask with no child_proc
2261 associated with it. (It is removed when the debugger
2262 exits the nested input loop and the error is thrown.) */
2264 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
2270 /* Add handles of child processes. */
2272 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
2273 /* Some child_procs might be sockets; ignore them. Also some
2274 children may have died already, but we haven't finished reading
2275 the process output; ignore them too. */
2276 if ((CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
)
2278 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
2279 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
2282 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
2287 /* Nothing to look for, so we didn't find anything */
2294 if (handle_file_notifications (NULL
))
2300 start_time
= GetTickCount ();
2302 /* Wait for input or child death to be signaled. If user input is
2303 allowed, then also accept window messages. */
2304 if (FD_ISSET (0, &orfds
))
2305 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
2308 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
2310 if (active
== WAIT_FAILED
)
2312 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2313 nh
+ nc
, timeout_ms
, GetLastError ()));
2314 /* don't return EBADF - this causes wait_reading_process_output to
2315 abort; WAIT_FAILED is returned when single-stepping under
2316 Windows 95 after switching thread focus in debugger, and
2317 possibly at other times. */
2321 else if (active
== WAIT_TIMEOUT
)
2325 if (handle_file_notifications (NULL
))
2330 else if (active
>= WAIT_OBJECT_0
2331 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
2333 active
-= WAIT_OBJECT_0
;
2335 else if (active
>= WAIT_ABANDONED_0
2336 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
2338 active
-= WAIT_ABANDONED_0
;
2343 /* Loop over all handles after active (now officially documented as
2344 being the first signaled handle in the array). We do this to
2345 ensure fairness, so that all channels with data available will be
2346 processed - otherwise higher numbered channels could be starved. */
2349 if (active
== nh
+ nc
)
2351 /* There are messages in the lisp thread's queue; we must
2352 drain the queue now to ensure they are processed promptly,
2353 because if we don't do so, we will not be woken again until
2354 further messages arrive.
2356 NB. If ever we allow window message procedures to callback
2357 into lisp, we will need to ensure messages are dispatched
2358 at a safe time for lisp code to be run (*), and we may also
2359 want to provide some hooks in the dispatch loop to cater
2360 for modeless dialogs created by lisp (ie. to register
2361 window handles to pass to IsDialogMessage).
2363 (*) Note that MsgWaitForMultipleObjects above is an
2364 internal dispatch point for messages that are sent to
2365 windows created by this thread. */
2366 if (drain_message_queue ()
2367 /* If drain_message_queue returns non-zero, that means
2368 we received a WM_EMACS_FILENOTIFY message. If this
2369 is a TTY frame, we must signal the caller that keyboard
2370 input is available, so that w32_console_read_socket
2371 will be called to pick up the notifications. If we
2372 don't do that, file notifications will only work when
2373 the Emacs TTY frame has focus. */
2374 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2375 /* they asked for stdin reads */
2376 && FD_ISSET (0, &orfds
)
2377 /* the stdin handle is valid */
2385 else if (active
>= nh
)
2387 cp
= cps
[active
- nh
];
2389 /* We cannot always signal SIGCHLD immediately; if we have not
2390 finished reading the process output, we must delay sending
2391 SIGCHLD until we do. */
2393 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
2394 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
2395 /* SIG_DFL for SIGCHLD is ignored */
2396 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2397 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2400 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2403 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2406 else if (fdindex
[active
] == -1)
2408 /* Quit (C-g) was detected. */
2412 else if (rfds
&& fdindex
[active
] == 0)
2414 /* Keyboard input available */
2420 /* Must be a socket or pipe - read ahead should have
2421 completed, either succeeding or failing. If this handle
2422 was waiting for an async 'connect', reset the connect
2423 flag, so it could read from now on. */
2424 if (wfds
&& (fd_info
[fdindex
[active
]].flags
& FILE_CONNECT
) != 0)
2426 cp
= fd_info
[fdindex
[active
]].cp
;
2429 /* Don't reset the FILE_CONNECT bit and don't
2430 acknowledge the read if the status is
2431 STATUS_CONNECT_FAILED or some other
2432 failure. That's because the thread exits in those
2433 cases, so it doesn't need the ACK, and we want to
2434 keep the FILE_CONNECT bit as evidence that the
2435 connect failed, to be checked in sys_read. */
2436 if (cp
->status
== STATUS_READ_SUCCEEDED
)
2438 fd_info
[cp
->fd
].flags
&= ~FILE_CONNECT
;
2439 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
2441 ResetEvent (cp
->char_avail
);
2443 FD_SET (fdindex
[active
], wfds
);
2446 FD_SET (fdindex
[active
], rfds
);
2450 /* Even though wait_reading_process_output only reads from at most
2451 one channel, we must process all channels here so that we reap
2452 all children that have died. */
2453 while (++active
< nh
+ nc
)
2454 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2456 } while (active
< nh
+ nc
);
2460 if (handle_file_notifications (NULL
))
2464 /* If no input has arrived and timeout hasn't expired, wait again. */
2467 DWORD elapsed
= GetTickCount () - start_time
;
2469 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2471 if (timeout_ms
!= INFINITE
)
2472 timeout_ms
-= elapsed
;
2473 goto count_children
;
2480 /* Substitute for certain kill () operations */
2482 static BOOL CALLBACK
2483 find_child_console (HWND hwnd
, LPARAM arg
)
2485 child_process
* cp
= (child_process
*) arg
;
2488 GetWindowThreadProcessId (hwnd
, &process_id
);
2489 if (process_id
== cp
->procinfo
.dwProcessId
)
2491 char window_class
[32];
2493 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2494 if (strcmp (window_class
,
2495 (os_subtype
== OS_9X
)
2497 : "ConsoleWindowClass") == 0)
2507 typedef BOOL (WINAPI
* DebugBreakProcess_Proc
) (
2510 /* Emulate 'kill', but only for other processes. */
2512 sys_kill (pid_t pid
, int sig
)
2516 int need_to_free
= 0;
2519 /* Each process is in its own process group. */
2523 /* Only handle signals that can be mapped to a similar behavior on Windows */
2525 && sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
&& sig
!= SIGTRAP
)
2533 /* It will take _some_ time before PID 4 or less on Windows will
2540 proc_hand
= OpenProcess (PROCESS_QUERY_INFORMATION
, 0, pid
);
2541 if (proc_hand
== NULL
)
2543 DWORD err
= GetLastError ();
2547 case ERROR_ACCESS_DENIED
: /* existing process, but access denied */
2550 case ERROR_INVALID_PARAMETER
: /* process PID does not exist */
2556 CloseHandle (proc_hand
);
2560 cp
= find_child_pid (pid
);
2563 /* We were passed a PID of something other than our subprocess.
2564 If that is our own PID, we will send to ourself a message to
2565 close the selected frame, which does not necessarily
2566 terminates Emacs. But then we are not supposed to call
2567 sys_kill with our own PID. */
2569 DWORD desiredAccess
=
2570 (sig
== SIGTRAP
) ? PROCESS_ALL_ACCESS
: PROCESS_TERMINATE
;
2572 proc_hand
= OpenProcess (desiredAccess
, 0, pid
);
2573 if (proc_hand
== NULL
)
2582 proc_hand
= cp
->procinfo
.hProcess
;
2583 pid
= cp
->procinfo
.dwProcessId
;
2585 /* Try to locate console window for process. */
2586 EnumWindows (find_child_console
, (LPARAM
) cp
);
2589 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2591 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2593 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2594 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2595 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2596 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2597 HWND foreground_window
;
2599 if (break_scan_code
== 0)
2601 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2602 vk_break_code
= 'C';
2603 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2606 foreground_window
= GetForegroundWindow ();
2607 if (foreground_window
)
2609 /* NT 5.0, and apparently also Windows 98, will not allow
2610 a Window to be set to foreground directly without the
2611 user's involvement. The workaround is to attach
2612 ourselves to the thread that owns the foreground
2613 window, since that is the only thread that can set the
2614 foreground window. */
2615 DWORD foreground_thread
, child_thread
;
2617 GetWindowThreadProcessId (foreground_window
, NULL
);
2618 if (foreground_thread
== GetCurrentThreadId ()
2619 || !AttachThreadInput (GetCurrentThreadId (),
2620 foreground_thread
, TRUE
))
2621 foreground_thread
= 0;
2623 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2624 if (child_thread
== GetCurrentThreadId ()
2625 || !AttachThreadInput (GetCurrentThreadId (),
2626 child_thread
, TRUE
))
2629 /* Set the foreground window to the child. */
2630 if (SetForegroundWindow (cp
->hwnd
))
2632 /* Generate keystrokes as if user had typed Ctrl-Break or
2634 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2635 keybd_event (vk_break_code
, break_scan_code
,
2636 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2637 keybd_event (vk_break_code
, break_scan_code
,
2638 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2639 | KEYEVENTF_KEYUP
, 0);
2640 keybd_event (VK_CONTROL
, control_scan_code
,
2641 KEYEVENTF_KEYUP
, 0);
2643 /* Sleep for a bit to give time for Emacs frame to respond
2644 to focus change events (if Emacs was active app). */
2647 SetForegroundWindow (foreground_window
);
2649 /* Detach from the foreground and child threads now that
2650 the foreground switching is over. */
2651 if (foreground_thread
)
2652 AttachThreadInput (GetCurrentThreadId (),
2653 foreground_thread
, FALSE
);
2655 AttachThreadInput (GetCurrentThreadId (),
2656 child_thread
, FALSE
);
2659 /* Ctrl-Break is NT equivalent of SIGINT. */
2660 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2662 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2663 "for pid %lu\n", GetLastError (), pid
));
2668 else if (sig
== SIGTRAP
)
2670 static DebugBreakProcess_Proc s_pfn_Debug_Break_Process
= NULL
;
2672 if (g_b_init_debug_break_process
== 0)
2674 g_b_init_debug_break_process
= 1;
2675 s_pfn_Debug_Break_Process
= (DebugBreakProcess_Proc
)
2676 GetProcAddress (GetModuleHandle ("kernel32.dll"),
2677 "DebugBreakProcess");
2680 if (s_pfn_Debug_Break_Process
== NULL
)
2685 else if (!s_pfn_Debug_Break_Process (proc_hand
))
2687 DWORD err
= GetLastError ();
2689 DebPrint (("sys_kill.DebugBreakProcess return %d "
2690 "for pid %lu\n", err
, pid
));
2694 case ERROR_ACCESS_DENIED
:
2707 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2710 if (os_subtype
== OS_9X
)
2713 Another possibility is to try terminating the VDM out-right by
2714 calling the Shell VxD (id 0x17) V86 interface, function #4
2715 "SHELL_Destroy_VM", ie.
2721 First need to determine the current VM handle, and then arrange for
2722 the shellapi call to be made from the system vm (by using
2723 Switch_VM_and_callback).
2725 Could try to invoke DestroyVM through CallVxD.
2729 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2730 to hang when cmdproxy is used in conjunction with
2731 command.com for an interactive shell. Posting
2732 WM_CLOSE pops up a dialog that, when Yes is selected,
2733 does the same thing. TerminateProcess is also less
2734 than ideal in that subprocesses tend to stick around
2735 until the machine is shutdown, but at least it
2736 doesn't freeze the 16-bit subsystem. */
2737 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2739 if (!TerminateProcess (proc_hand
, 0xff))
2741 DebPrint (("sys_kill.TerminateProcess returned %d "
2742 "for pid %lu\n", GetLastError (), pid
));
2749 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2751 /* Kill the process. On W32 this doesn't kill child processes
2752 so it doesn't work very well for shells which is why it's not
2753 used in every case. */
2754 else if (!TerminateProcess (proc_hand
, 0xff))
2756 DebPrint (("sys_kill.TerminateProcess returned %d "
2757 "for pid %lu\n", GetLastError (), pid
));
2764 CloseHandle (proc_hand
);
2769 /* The following two routines are used to manipulate stdin, stdout, and
2770 stderr of our child processes.
2772 Assuming that in, out, and err are *not* inheritable, we make them
2773 stdin, stdout, and stderr of the child as follows:
2775 - Save the parent's current standard handles.
2776 - Set the std handles to inheritable duplicates of the ones being passed in.
2777 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2778 NT file handle for a crt file descriptor.)
2779 - Spawn the child, which inherits in, out, and err as stdin,
2780 stdout, and stderr. (see Spawnve)
2781 - Close the std handles passed to the child.
2782 - Reset the parent's standard handles to the saved handles.
2783 (see reset_standard_handles)
2784 We assume that the caller closes in, out, and err after calling us. */
2787 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2790 HANDLE newstdin
, newstdout
, newstderr
;
2792 parent
= GetCurrentProcess ();
2794 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2795 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2796 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2798 /* make inheritable copies of the new handles */
2799 if (!DuplicateHandle (parent
,
2800 (HANDLE
) _get_osfhandle (in
),
2805 DUPLICATE_SAME_ACCESS
))
2806 report_file_error ("Duplicating input handle for child", Qnil
);
2808 if (!DuplicateHandle (parent
,
2809 (HANDLE
) _get_osfhandle (out
),
2814 DUPLICATE_SAME_ACCESS
))
2815 report_file_error ("Duplicating output handle for child", Qnil
);
2817 if (!DuplicateHandle (parent
,
2818 (HANDLE
) _get_osfhandle (err
),
2823 DUPLICATE_SAME_ACCESS
))
2824 report_file_error ("Duplicating error handle for child", Qnil
);
2826 /* and store them as our std handles */
2827 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2828 report_file_error ("Changing stdin handle", Qnil
);
2830 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2831 report_file_error ("Changing stdout handle", Qnil
);
2833 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2834 report_file_error ("Changing stderr handle", Qnil
);
2838 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2840 /* close the duplicated handles passed to the child */
2841 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2842 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2843 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2845 /* now restore parent's saved std handles */
2846 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2847 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2848 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2852 set_process_dir (char * dir
)
2857 /* To avoid problems with winsock implementations that work over dial-up
2858 connections causing or requiring a connection to exist while Emacs is
2859 running, Emacs no longer automatically loads winsock on startup if it
2860 is present. Instead, it will be loaded when open-network-stream is
2863 To allow full control over when winsock is loaded, we provide these
2864 two functions to dynamically load and unload winsock. This allows
2865 dial-up users to only be connected when they actually need to use
2869 extern HANDLE winsock_lib
;
2870 extern BOOL
term_winsock (void);
2872 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2873 doc
: /* Test for presence of the Windows socket library `winsock'.
2874 Returns non-nil if winsock support is present, nil otherwise.
2876 If the optional argument LOAD-NOW is non-nil, the winsock library is
2877 also loaded immediately if not already loaded. If winsock is loaded,
2878 the winsock local hostname is returned (since this may be different from
2879 the value of `system-name' and should supplant it), otherwise t is
2880 returned to indicate winsock support is present. */)
2881 (Lisp_Object load_now
)
2885 have_winsock
= init_winsock (!NILP (load_now
));
2888 if (winsock_lib
!= NULL
)
2890 /* Return new value for system-name. The best way to do this
2891 is to call init_system_name, saving and restoring the
2892 original value to avoid side-effects. */
2893 Lisp_Object orig_hostname
= Vsystem_name
;
2894 Lisp_Object hostname
;
2896 init_system_name ();
2897 hostname
= Vsystem_name
;
2898 Vsystem_name
= orig_hostname
;
2906 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2908 doc
: /* Unload the Windows socket library `winsock' if loaded.
2909 This is provided to allow dial-up socket connections to be disconnected
2910 when no longer needed. Returns nil without unloading winsock if any
2911 socket connections still exist. */)
2914 return term_winsock () ? Qt
: Qnil
;
2918 /* Some miscellaneous functions that are Windows specific, but not GUI
2919 specific (ie. are applicable in terminal or batch mode as well). */
2921 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2922 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2923 If FILENAME does not exist, return nil.
2924 All path elements in FILENAME are converted to their short names. */)
2925 (Lisp_Object filename
)
2927 char shortname
[MAX_PATH
];
2929 CHECK_STRING (filename
);
2931 /* first expand it. */
2932 filename
= Fexpand_file_name (filename
, Qnil
);
2934 /* luckily, this returns the short version of each element in the path. */
2935 if (w32_get_short_filename (SSDATA (ENCODE_FILE (filename
)),
2936 shortname
, MAX_PATH
) == 0)
2939 dostounix_filename (shortname
);
2941 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2942 return build_string (shortname
);
2946 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2948 doc
: /* Return the long file name version of the full path of FILENAME.
2949 If FILENAME does not exist, return nil.
2950 All path elements in FILENAME are converted to their long names. */)
2951 (Lisp_Object filename
)
2953 char longname
[ MAX_UTF8_PATH
];
2956 CHECK_STRING (filename
);
2958 if (SBYTES (filename
) == 2
2959 && *(SDATA (filename
) + 1) == ':')
2962 /* first expand it. */
2963 filename
= Fexpand_file_name (filename
, Qnil
);
2965 if (!w32_get_long_filename (SSDATA (ENCODE_FILE (filename
)), longname
,
2969 dostounix_filename (longname
);
2971 /* If we were passed only a drive, make sure that a slash is not appended
2972 for consistency with directories. Allow for drive mapping via SUBST
2973 in case expand-file-name is ever changed to expand those. */
2974 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2977 return DECODE_FILE (build_unibyte_string (longname
));
2980 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2981 Sw32_set_process_priority
, 2, 2, 0,
2982 doc
: /* Set the priority of PROCESS to PRIORITY.
2983 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2984 priority of the process whose pid is PROCESS is changed.
2985 PRIORITY should be one of the symbols high, normal, or low;
2986 any other symbol will be interpreted as normal.
2988 If successful, the return value is t, otherwise nil. */)
2989 (Lisp_Object process
, Lisp_Object priority
)
2991 HANDLE proc_handle
= GetCurrentProcess ();
2992 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2993 Lisp_Object result
= Qnil
;
2995 CHECK_SYMBOL (priority
);
2997 if (!NILP (process
))
3002 CHECK_NUMBER (process
);
3004 /* Allow pid to be an internally generated one, or one obtained
3005 externally. This is necessary because real pids on Windows 95 are
3008 pid
= XINT (process
);
3009 cp
= find_child_pid (pid
);
3011 pid
= cp
->procinfo
.dwProcessId
;
3013 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
3016 if (EQ (priority
, Qhigh
))
3017 priority_class
= HIGH_PRIORITY_CLASS
;
3018 else if (EQ (priority
, Qlow
))
3019 priority_class
= IDLE_PRIORITY_CLASS
;
3021 if (proc_handle
!= NULL
)
3023 if (SetPriorityClass (proc_handle
, priority_class
))
3025 if (!NILP (process
))
3026 CloseHandle (proc_handle
);
3032 DEFUN ("w32-application-type", Fw32_application_type
,
3033 Sw32_application_type
, 1, 1, 0,
3034 doc
: /* Return the type of an MS-Windows PROGRAM.
3036 Knowing the type of an executable could be useful for formatting
3037 file names passed to it or for quoting its command-line arguments.
3039 PROGRAM should specify an executable file, including the extension.
3041 The value is one of the following:
3043 `dos' -- a DOS .com program or some other non-PE executable
3044 `cygwin' -- a Cygwin program that depends on Cygwin DLL
3045 `msys' -- an MSYS 1.x or MSYS2 program
3046 `w32-native' -- a native Windows application
3047 `unknown' -- a file that doesn't exist, or cannot be open, or whose
3048 name is not encodable in the current ANSI codepage.
3050 Note that for .bat and .cmd batch files the function returns the type
3051 of their command interpreter, as specified by the \"COMSPEC\"
3052 environment variable.
3054 This function returns `unknown' for programs whose file names
3055 include characters not supported by the current ANSI codepage, as
3056 such programs cannot be invoked by Emacs anyway. */)
3057 (Lisp_Object program
)
3059 int is_dos_app
, is_cygwin_app
, is_msys_app
, dummy
;
3060 Lisp_Object encoded_progname
;
3061 char *progname
, progname_a
[MAX_PATH
];
3063 program
= Fexpand_file_name (program
, Qnil
);
3064 encoded_progname
= ENCODE_FILE (program
);
3065 progname
= SSDATA (encoded_progname
);
3066 unixtodos_filename (progname
);
3067 filename_to_ansi (progname
, progname_a
);
3068 /* Reject file names that cannot be encoded in the current ANSI
3070 if (_mbspbrk ((unsigned char *)progname_a
, (const unsigned char *)"?"))
3073 if (w32_executable_type (progname_a
, &is_dos_app
, &is_cygwin_app
,
3074 &is_msys_app
, &dummy
) != 0)
3085 #ifdef HAVE_LANGINFO_CODESET
3086 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
3088 nl_langinfo (nl_item item
)
3090 /* Conversion of Posix item numbers to their Windows equivalents. */
3091 static const LCTYPE w32item
[] = {
3092 LOCALE_IDEFAULTANSICODEPAGE
,
3093 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
3094 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
3095 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
3096 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
3097 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
3098 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
3101 static char *nl_langinfo_buf
= NULL
;
3102 static int nl_langinfo_len
= 0;
3104 if (nl_langinfo_len
<= 0)
3105 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
3107 if (item
< 0 || item
>= _NL_NUM
)
3108 nl_langinfo_buf
[0] = 0;
3111 LCID cloc
= GetThreadLocale ();
3112 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
3116 nl_langinfo_buf
[0] = 0;
3119 if (item
== CODESET
)
3121 need_len
+= 2; /* for the "cp" prefix */
3122 if (need_len
< 8) /* for the case we call GetACP */
3125 if (nl_langinfo_len
<= need_len
)
3126 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
3127 nl_langinfo_len
= need_len
);
3128 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
3129 nl_langinfo_buf
, nl_langinfo_len
))
3130 nl_langinfo_buf
[0] = 0;
3131 else if (item
== CODESET
)
3133 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
3134 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
3135 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
3138 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
3139 strlen (nl_langinfo_buf
) + 1);
3140 nl_langinfo_buf
[0] = 'c';
3141 nl_langinfo_buf
[1] = 'p';
3146 return nl_langinfo_buf
;
3148 #endif /* HAVE_LANGINFO_CODESET */
3150 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
3151 Sw32_get_locale_info
, 1, 2, 0,
3152 doc
: /* Return information about the Windows locale LCID.
3153 By default, return a three letter locale code which encodes the default
3154 language as the first two characters, and the country or regional variant
3155 as the third letter. For example, ENU refers to `English (United States)',
3156 while ENC means `English (Canadian)'.
3158 If the optional argument LONGFORM is t, the long form of the locale
3159 name is returned, e.g. `English (United States)' instead; if LONGFORM
3160 is a number, it is interpreted as an LCTYPE constant and the corresponding
3161 locale information is returned.
3163 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
3164 (Lisp_Object lcid
, Lisp_Object longform
)
3168 char abbrev_name
[32] = { 0 };
3169 char full_name
[256] = { 0 };
3171 CHECK_NUMBER (lcid
);
3173 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
3176 if (NILP (longform
))
3178 got_abbrev
= GetLocaleInfo (XINT (lcid
),
3179 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
3180 abbrev_name
, sizeof (abbrev_name
));
3182 return build_string (abbrev_name
);
3184 else if (EQ (longform
, Qt
))
3186 got_full
= GetLocaleInfo (XINT (lcid
),
3187 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
3188 full_name
, sizeof (full_name
));
3190 return DECODE_SYSTEM (build_string (full_name
));
3192 else if (NUMBERP (longform
))
3194 got_full
= GetLocaleInfo (XINT (lcid
),
3196 full_name
, sizeof (full_name
));
3197 /* GetLocaleInfo's return value includes the terminating null
3198 character, when the returned information is a string, whereas
3199 make_unibyte_string needs the string length without the
3200 terminating null. */
3202 return make_unibyte_string (full_name
, got_full
- 1);
3209 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
3210 Sw32_get_current_locale_id
, 0, 0, 0,
3211 doc
: /* Return Windows locale id for current locale setting.
3212 This is a numerical value; use `w32-get-locale-info' to convert to a
3213 human-readable form. */)
3216 return make_number (GetThreadLocale ());
3220 int_from_hex (char * s
)
3223 static char hex
[] = "0123456789abcdefABCDEF";
3226 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
3228 unsigned digit
= p
- hex
;
3231 val
= val
* 16 + digit
;
3237 /* We need to build a global list, since the EnumSystemLocale callback
3238 function isn't given a context pointer. */
3239 Lisp_Object Vw32_valid_locale_ids
;
3241 static BOOL CALLBACK ALIGN_STACK
3242 enum_locale_fn (LPTSTR localeNum
)
3244 DWORD id
= int_from_hex (localeNum
);
3245 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
3249 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
3250 Sw32_get_valid_locale_ids
, 0, 0, 0,
3251 doc
: /* Return list of all valid Windows locale ids.
3252 Each id is a numerical value; use `w32-get-locale-info' to convert to a
3253 human-readable form. */)
3256 Vw32_valid_locale_ids
= Qnil
;
3258 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
3260 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
3261 return Vw32_valid_locale_ids
;
3265 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
3266 doc
: /* Return Windows locale id for default locale setting.
3267 By default, the system default locale setting is returned; if the optional
3268 parameter USERP is non-nil, the user default locale setting is returned.
3269 This is a numerical value; use `w32-get-locale-info' to convert to a
3270 human-readable form. */)
3274 return make_number (GetSystemDefaultLCID ());
3275 return make_number (GetUserDefaultLCID ());
3279 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
3280 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
3281 If successful, the new locale id is returned, otherwise nil. */)
3284 CHECK_NUMBER (lcid
);
3286 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
3289 if (!SetThreadLocale (XINT (lcid
)))
3292 /* Need to set input thread locale if present. */
3293 if (dwWindowsThreadId
)
3294 /* Reply is not needed. */
3295 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
3297 return make_number (GetThreadLocale ());
3301 /* We need to build a global list, since the EnumCodePages callback
3302 function isn't given a context pointer. */
3303 Lisp_Object Vw32_valid_codepages
;
3305 static BOOL CALLBACK ALIGN_STACK
3306 enum_codepage_fn (LPTSTR codepageNum
)
3308 DWORD id
= atoi (codepageNum
);
3309 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
3313 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
3314 Sw32_get_valid_codepages
, 0, 0, 0,
3315 doc
: /* Return list of all valid Windows codepages. */)
3318 Vw32_valid_codepages
= Qnil
;
3320 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
3322 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
3323 return Vw32_valid_codepages
;
3327 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
3328 Sw32_get_console_codepage
, 0, 0, 0,
3329 doc
: /* Return current Windows codepage for console input. */)
3332 return make_number (GetConsoleCP ());
3336 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
3337 Sw32_set_console_codepage
, 1, 1, 0,
3338 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
3339 This codepage setting affects keyboard input in tty mode.
3340 If successful, the new CP is returned, otherwise nil. */)
3345 if (!IsValidCodePage (XINT (cp
)))
3348 if (!SetConsoleCP (XINT (cp
)))
3351 return make_number (GetConsoleCP ());
3355 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
3356 Sw32_get_console_output_codepage
, 0, 0, 0,
3357 doc
: /* Return current Windows codepage for console output. */)
3360 return make_number (GetConsoleOutputCP ());
3364 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
3365 Sw32_set_console_output_codepage
, 1, 1, 0,
3366 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
3367 This codepage setting affects display in tty mode.
3368 If successful, the new CP is returned, otherwise nil. */)
3373 if (!IsValidCodePage (XINT (cp
)))
3376 if (!SetConsoleOutputCP (XINT (cp
)))
3379 return make_number (GetConsoleOutputCP ());
3383 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
3384 Sw32_get_codepage_charset
, 1, 1, 0,
3385 doc
: /* Return charset ID corresponding to codepage CP.
3386 Returns nil if the codepage is not valid or its charset ID could
3389 Note that this function is only guaranteed to work with ANSI
3390 codepages; most console codepages are not supported and will
3399 if (!IsValidCodePage (XINT (cp
)))
3402 /* Going through a temporary DWORD_PTR variable avoids compiler warning
3403 about cast to pointer from integer of different size, when
3404 building --with-wide-int or building for 64bit. */
3406 if (TranslateCharsetInfo ((DWORD
*) dwcp
, &info
, TCI_SRCCODEPAGE
))
3407 return make_number (info
.ciCharset
);
3413 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
3414 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
3415 doc
: /* Return list of Windows keyboard languages and layouts.
3416 The return value is a list of pairs of language id and layout id. */)
3419 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
3420 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
3421 Lisp_Object obj
= Qnil
;
3423 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
3425 while (--num_layouts
>= 0)
3427 HKL kl
= layouts
[num_layouts
];
3429 obj
= Fcons (Fcons (make_number (LOWORD (kl
)),
3430 make_number (HIWORD (kl
))),
3439 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
3440 Sw32_get_keyboard_layout
, 0, 0, 0,
3441 doc
: /* Return current Windows keyboard language and layout.
3442 The return value is the cons of the language id and the layout id. */)
3445 HKL kl
= GetKeyboardLayout (dwWindowsThreadId
);
3447 return Fcons (make_number (LOWORD (kl
)),
3448 make_number (HIWORD (kl
)));
3452 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
3453 Sw32_set_keyboard_layout
, 1, 1, 0,
3454 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
3455 The keyboard layout setting affects interpretation of keyboard input.
3456 If successful, the new layout id is returned, otherwise nil. */)
3457 (Lisp_Object layout
)
3461 CHECK_CONS (layout
);
3462 CHECK_NUMBER_CAR (layout
);
3463 CHECK_NUMBER_CDR (layout
);
3465 kl
= (HKL
) (UINT_PTR
) ((XINT (XCAR (layout
)) & 0xffff)
3466 | (XINT (XCDR (layout
)) << 16));
3468 /* Synchronize layout with input thread. */
3469 if (dwWindowsThreadId
)
3471 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
3475 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
3477 if (msg
.wParam
== 0)
3481 else if (!ActivateKeyboardLayout (kl
, 0))
3484 return Fw32_get_keyboard_layout ();
3487 /* Two variables to interface between get_lcid and the EnumLocales
3488 callback function below. */
3489 #ifndef LOCALE_NAME_MAX_LENGTH
3490 # define LOCALE_NAME_MAX_LENGTH 85
3492 static LCID found_lcid
;
3493 static char lname
[3 * LOCALE_NAME_MAX_LENGTH
+ 1 + 1];
3495 /* Callback function for EnumLocales. */
3496 static BOOL CALLBACK
3497 get_lcid_callback (LPTSTR locale_num_str
)
3500 char locval
[2 * LOCALE_NAME_MAX_LENGTH
+ 1 + 1];
3501 LCID try_lcid
= strtoul (locale_num_str
, &endp
, 16);
3503 if (GetLocaleInfo (try_lcid
, LOCALE_SABBREVLANGNAME
,
3504 locval
, LOCALE_NAME_MAX_LENGTH
))
3508 /* This is for when they only specify the language, as in "ENU". */
3509 if (stricmp (locval
, lname
) == 0)
3511 found_lcid
= try_lcid
;
3514 locval_len
= strlen (locval
);
3515 strcpy (locval
+ locval_len
, "_");
3516 if (GetLocaleInfo (try_lcid
, LOCALE_SABBREVCTRYNAME
,
3517 locval
+ locval_len
+ 1, LOCALE_NAME_MAX_LENGTH
))
3519 locval_len
= strlen (locval
);
3520 if (strnicmp (locval
, lname
, locval_len
) == 0
3521 && (lname
[locval_len
] == '.'
3522 || lname
[locval_len
] == '\0'))
3524 found_lcid
= try_lcid
;
3532 /* Return the Locale ID (LCID) number given the locale's name, a
3533 string, in LOCALE_NAME. This works by enumerating all the locales
3534 supported by the system, until we find one whose name matches
3537 get_lcid (const char *locale_name
)
3539 /* A simple cache. */
3540 static LCID last_lcid
;
3541 static char last_locale
[1000];
3543 /* The code below is not thread-safe, as it uses static variables.
3544 But this function is called only from the Lisp thread. */
3545 if (last_lcid
> 0 && strcmp (locale_name
, last_locale
) == 0)
3548 strncpy (lname
, locale_name
, sizeof (lname
) - 1);
3549 lname
[sizeof (lname
) - 1] = '\0';
3551 EnumSystemLocales (get_lcid_callback
, LCID_SUPPORTED
);
3554 last_lcid
= found_lcid
;
3555 strcpy (last_locale
, locale_name
);
3560 #ifndef _NLSCMPERROR
3561 # define _NLSCMPERROR INT_MAX
3563 #ifndef LINGUISTIC_IGNORECASE
3564 # define LINGUISTIC_IGNORECASE 0x00000010
3567 typedef int (WINAPI
*CompareStringW_Proc
)
3568 (LCID
, DWORD
, LPCWSTR
, int, LPCWSTR
, int);
3571 w32_compare_strings (const char *s1
, const char *s2
, char *locname
,
3574 LCID lcid
= GetThreadLocale ();
3575 wchar_t *string1_w
, *string2_w
;
3577 static CompareStringW_Proc pCompareStringW
;
3582 /* The LCID machinery doesn't seem to support the "C" locale, so we
3583 need to do that by hand. */
3585 && ((locname
[0] == 'C' && (locname
[1] == '\0' || locname
[1] == '.'))
3586 || strcmp (locname
, "POSIX") == 0))
3587 return (ignore_case
? stricmp (s1
, s2
) : strcmp (s1
, s2
));
3589 if (!g_b_init_compare_string_w
)
3591 if (os_subtype
== OS_9X
)
3594 (CompareStringW_Proc
) GetProcAddress (LoadLibrary ("Unicows.dll"),
3596 if (!pCompareStringW
)
3599 /* This return value is compatible with wcscoll and
3600 other MS CRT functions. */
3601 return _NLSCMPERROR
;
3605 pCompareStringW
= CompareStringW
;
3607 g_b_init_compare_string_w
= 1;
3610 needed
= pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s1
, -1, NULL
, 0);
3613 SAFE_NALLOCA (string1_w
, 1, needed
+ 1);
3614 pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s1
, -1,
3620 return _NLSCMPERROR
;
3623 needed
= pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s2
, -1, NULL
, 0);
3626 SAFE_NALLOCA (string2_w
, 1, needed
+ 1);
3627 pMultiByteToWideChar (CP_UTF8
, MB_ERR_INVALID_CHARS
, s2
, -1,
3634 return _NLSCMPERROR
;
3639 /* Convert locale name string to LCID. We don't want to use
3640 LocaleNameToLCID because (a) it is only available since
3641 Vista, and (b) it doesn't accept locale names returned by
3642 'setlocale' and 'GetLocaleInfo'. */
3643 LCID new_lcid
= get_lcid (locname
);
3648 error ("Invalid locale %s: Invalid argument", locname
);
3653 /* NORM_IGNORECASE ignores any tertiary distinction, not just
3654 case variants. LINGUISTIC_IGNORECASE is more selective, and
3655 is sensitive to the locale's language, but it is not
3656 available before Vista. */
3657 if (w32_major_version
>= 6)
3658 flags
|= LINGUISTIC_IGNORECASE
;
3660 flags
|= NORM_IGNORECASE
;
3662 /* This approximates what glibc collation functions do when the
3663 locale's codeset is UTF-8. */
3664 if (!NILP (Vw32_collate_ignore_punctuation
))
3665 flags
|= NORM_IGNORESYMBOLS
;
3666 val
= pCompareStringW (lcid
, flags
, string1_w
, -1, string2_w
, -1);
3671 return _NLSCMPERROR
;
3678 syms_of_ntproc (void)
3680 DEFSYM (Qhigh
, "high");
3681 DEFSYM (Qlow
, "low");
3682 DEFSYM (Qcygwin
, "cygwin");
3683 DEFSYM (Qmsys
, "msys");
3684 DEFSYM (Qw32_native
, "w32-native");
3686 defsubr (&Sw32_has_winsock
);
3687 defsubr (&Sw32_unload_winsock
);
3689 defsubr (&Sw32_short_file_name
);
3690 defsubr (&Sw32_long_file_name
);
3691 defsubr (&Sw32_set_process_priority
);
3692 defsubr (&Sw32_application_type
);
3693 defsubr (&Sw32_get_locale_info
);
3694 defsubr (&Sw32_get_current_locale_id
);
3695 defsubr (&Sw32_get_default_locale_id
);
3696 defsubr (&Sw32_get_valid_locale_ids
);
3697 defsubr (&Sw32_set_current_locale
);
3699 defsubr (&Sw32_get_console_codepage
);
3700 defsubr (&Sw32_set_console_codepage
);
3701 defsubr (&Sw32_get_console_output_codepage
);
3702 defsubr (&Sw32_set_console_output_codepage
);
3703 defsubr (&Sw32_get_valid_codepages
);
3704 defsubr (&Sw32_get_codepage_charset
);
3706 defsubr (&Sw32_get_valid_keyboard_layouts
);
3707 defsubr (&Sw32_get_keyboard_layout
);
3708 defsubr (&Sw32_set_keyboard_layout
);
3710 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
3711 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3712 Because Windows does not directly pass argv arrays to child processes,
3713 programs have to reconstruct the argv array by parsing the command
3714 line string. For an argument to contain a space, it must be enclosed
3715 in double quotes or it will be parsed as multiple arguments.
3717 If the value is a character, that character will be used to escape any
3718 quote characters that appear, otherwise a suitable escape character
3719 will be chosen based on the type of the program. */);
3720 Vw32_quote_process_args
= Qt
;
3722 DEFVAR_LISP ("w32-start-process-show-window",
3723 Vw32_start_process_show_window
,
3724 doc
: /* When nil, new child processes hide their windows.
3725 When non-nil, they show their window in the method of their choice.
3726 This variable doesn't affect GUI applications, which will never be hidden. */);
3727 Vw32_start_process_show_window
= Qnil
;
3729 DEFVAR_LISP ("w32-start-process-share-console",
3730 Vw32_start_process_share_console
,
3731 doc
: /* When nil, new child processes are given a new console.
3732 When non-nil, they share the Emacs console; this has the limitation of
3733 allowing only one DOS subprocess to run at a time (whether started directly
3734 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3735 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3736 otherwise respond to interrupts from Emacs. */);
3737 Vw32_start_process_share_console
= Qnil
;
3739 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3740 Vw32_start_process_inherit_error_mode
,
3741 doc
: /* When nil, new child processes revert to the default error mode.
3742 When non-nil, they inherit their error mode setting from Emacs, which stops
3743 them blocking when trying to access unmounted drives etc. */);
3744 Vw32_start_process_inherit_error_mode
= Qt
;
3746 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
3747 doc
: /* Forced delay before reading subprocess output.
3748 This is done to improve the buffering of subprocess output, by
3749 avoiding the inefficiency of frequently reading small amounts of data.
3751 If positive, the value is the number of milliseconds to sleep before
3752 reading the subprocess output. If negative, the magnitude is the number
3753 of time slices to wait (effectively boosting the priority of the child
3754 process temporarily). A value of zero disables waiting entirely. */);
3755 w32_pipe_read_delay
= 50;
3757 DEFVAR_INT ("w32-pipe-buffer-size", w32_pipe_buffer_size
,
3758 doc
: /* Size of buffer for pipes created to communicate with subprocesses.
3759 The size is in bytes, and must be non-negative. The default is zero,
3760 which lets the OS use its default size, usually 4KB (4096 bytes).
3761 Any negative value means to use the default value of zero. */);
3762 w32_pipe_buffer_size
= 0;
3764 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
3765 doc
: /* Non-nil means convert all-upper case file names to lower case.
3766 This applies when performing completions and file name expansion.
3767 Note that the value of this setting also affects remote file names,
3768 so you probably don't want to set to non-nil if you use case-sensitive
3769 filesystems via ange-ftp. */);
3770 Vw32_downcase_file_names
= Qnil
;
3773 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3774 doc
: /* Non-nil means attempt to fake realistic inode values.
3775 This works by hashing the truename of files, and should detect
3776 aliasing between long and short (8.3 DOS) names, but can have
3777 false positives because of hash collisions. Note that determining
3778 the truename of a file can be slow. */);
3779 Vw32_generate_fake_inodes
= Qnil
;
3782 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3783 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3784 This option controls whether to issue additional system calls to determine
3785 accurate link counts, file type, and ownership information. It is more
3786 useful for files on NTFS volumes, where hard links and file security are
3787 supported, than on volumes of the FAT family.
3789 Without these system calls, link count will always be reported as 1 and file
3790 ownership will be attributed to the current user.
3791 The default value `local' means only issue these system calls for files
3792 on local fixed drives. A value of nil means never issue them.
3793 Any other non-nil value means do this even on remote and removable drives
3794 where the performance impact may be noticeable even on modern hardware. */);
3795 Vw32_get_true_file_attributes
= Qlocal
;
3797 DEFVAR_LISP ("w32-collate-ignore-punctuation",
3798 Vw32_collate_ignore_punctuation
,
3799 doc
: /* Non-nil causes string collation functions ignore punctuation on MS-Windows.
3800 On Posix platforms, `string-collate-lessp' and `string-collate-equalp'
3801 ignore punctuation characters when they compare strings, if the
3802 locale's codeset is UTF-8, as in \"en_US.UTF-8\". Binding this option
3803 to a non-nil value will achieve a similar effect on MS-Windows, where
3804 locales with UTF-8 codeset are not supported.
3806 Note that setting this to non-nil will also ignore blanks and symbols
3807 in the strings. So do NOT use this option when comparing file names
3808 for equality, only when you need to sort them. */);
3809 Vw32_collate_ignore_punctuation
= Qnil
;
3811 staticpro (&Vw32_valid_locale_ids
);
3812 staticpro (&Vw32_valid_codepages
);
3814 /* end of w32proc.c */