1 /* Process support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1992, 1995, 1999-2013 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 Drew Bliss Oct 14, 1993
21 Adapted from alarm.c by Tim Fleehart
33 /* must include CRT headers *before* config.h */
44 /* This definition is missing from mingw32 headers. */
45 extern BOOL WINAPI
IsValidLocale (LCID
, DWORD
);
48 #ifdef HAVE_LANGINFO_CODESET
55 #include "w32common.h"
60 #include "syssignal.h"
62 #include "dispextern.h" /* for xstrcasecmp */
65 #define RVA_TO_PTR(var,section,filedata) \
66 ((void *)((section)->PointerToRawData \
67 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
68 + (filedata).file_base))
70 Lisp_Object Qhigh
, Qlow
;
72 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
73 static signal_handler sig_handlers
[NSIG
];
75 static sigset_t sig_mask
;
77 static CRITICAL_SECTION crit_sig
;
79 /* Improve on the CRT 'signal' implementation so that we could record
80 the SIGCHLD handler and fake interval timers. */
82 sys_signal (int sig
, signal_handler handler
)
86 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
87 below. SIGALRM and SIGPROF are used by setitimer. All the
88 others are the only ones supported by the MS runtime. */
89 if (!(sig
== SIGCHLD
|| sig
== SIGSEGV
|| sig
== SIGILL
90 || sig
== SIGFPE
|| sig
== SIGABRT
|| sig
== SIGTERM
91 || sig
== SIGALRM
|| sig
== SIGPROF
))
96 old
= sig_handlers
[sig
];
97 /* SIGABRT is treated specially because w32.c installs term_ntproc
98 as its handler, so we don't want to override that afterwards.
99 Aborting Emacs works specially anyway: either by calling
100 emacs_abort directly or through terminate_due_to_signal, which
101 calls emacs_abort through emacs_raise. */
102 if (!(sig
== SIGABRT
&& old
== term_ntproc
))
104 sig_handlers
[sig
] = handler
;
105 if (!(sig
== SIGCHLD
|| sig
== SIGALRM
|| sig
== SIGPROF
))
106 signal (sig
, handler
);
111 /* Emulate sigaction. */
113 sigaction (int sig
, const struct sigaction
*act
, struct sigaction
*oact
)
115 signal_handler old
= SIG_DFL
;
119 old
= sys_signal (sig
, act
->sa_handler
);
121 old
= sig_handlers
[sig
];
130 oact
->sa_handler
= old
;
132 oact
->sa_mask
= empty_mask
;
137 /* Emulate signal sets and blocking of signals used by timers. */
140 sigemptyset (sigset_t
*set
)
147 sigaddset (sigset_t
*set
, int signo
)
154 if (signo
< 0 || signo
>= NSIG
)
160 *set
|= (1U << signo
);
166 sigfillset (sigset_t
*set
)
179 sigprocmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
181 if (!(how
== SIG_BLOCK
|| how
== SIG_UNBLOCK
|| how
== SIG_SETMASK
))
202 /* FIXME: Catch signals that are blocked and reissue them when
203 they are unblocked. Important for SIGALRM and SIGPROF only. */
212 pthread_sigmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
214 if (sigprocmask (how
, set
, oset
) == -1)
220 sigismember (const sigset_t
*set
, int signo
)
222 if (signo
< 0 || signo
>= NSIG
)
227 if (signo
> sizeof (*set
) * BITS_PER_CHAR
)
230 return (*set
& (1U << signo
)) != 0;
234 setpgrp (int pid
, int gid
)
246 setpgid (pid_t pid
, pid_t pgid
)
251 /* Emulations of interval timers.
253 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
255 Implementation: a separate thread is started for each timer type,
256 the thread calls the appropriate signal handler when the timer
257 expires, after stopping the thread which installed the timer. */
260 volatile ULONGLONG expire
;
261 volatile ULONGLONG reload
;
262 volatile int terminate
;
264 HANDLE caller_thread
;
268 static ULONGLONG ticks_now
;
269 static struct itimer_data real_itimer
, prof_itimer
;
270 static ULONGLONG clocks_min
;
271 /* If non-zero, itimers are disabled. Used during shutdown, when we
272 delete the critical sections used by the timer threads. */
273 static int disable_itimers
;
275 static CRITICAL_SECTION crit_real
, crit_prof
;
277 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
278 typedef BOOL (WINAPI
*GetThreadTimes_Proc
) (
280 LPFILETIME lpCreationTime
,
281 LPFILETIME lpExitTime
,
282 LPFILETIME lpKernelTime
,
283 LPFILETIME lpUserTime
);
285 static GetThreadTimes_Proc s_pfn_Get_Thread_Times
;
287 #define MAX_SINGLE_SLEEP 30
288 #define TIMER_TICKS_PER_SEC 1000
290 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
291 to a thread. If THREAD is NULL or an invalid handle, return the
292 current wall-clock time since January 1, 1601 (UTC). Otherwise,
293 return the sum of kernel and user times used by THREAD since it was
294 created, plus its creation time. */
296 w32_get_timer_time (HANDLE thread
)
299 int use_system_time
= 1;
300 /* The functions below return times in 100-ns units. */
301 const int tscale
= 10 * TIMER_TICKS_PER_SEC
;
303 if (thread
&& thread
!= INVALID_HANDLE_VALUE
304 && s_pfn_Get_Thread_Times
!= NULL
)
306 FILETIME creation_ftime
, exit_ftime
, kernel_ftime
, user_ftime
;
307 ULARGE_INTEGER temp_creation
, temp_kernel
, temp_user
;
309 if (s_pfn_Get_Thread_Times (thread
, &creation_ftime
, &exit_ftime
,
310 &kernel_ftime
, &user_ftime
))
313 temp_creation
.LowPart
= creation_ftime
.dwLowDateTime
;
314 temp_creation
.HighPart
= creation_ftime
.dwHighDateTime
;
315 temp_kernel
.LowPart
= kernel_ftime
.dwLowDateTime
;
316 temp_kernel
.HighPart
= kernel_ftime
.dwHighDateTime
;
317 temp_user
.LowPart
= user_ftime
.dwLowDateTime
;
318 temp_user
.HighPart
= user_ftime
.dwHighDateTime
;
320 temp_creation
.QuadPart
/ tscale
+ temp_kernel
.QuadPart
/ tscale
321 + temp_user
.QuadPart
/ tscale
;
324 DebPrint (("GetThreadTimes failed with error code %lu\n",
330 FILETIME current_ftime
;
333 GetSystemTimeAsFileTime (¤t_ftime
);
335 temp
.LowPart
= current_ftime
.dwLowDateTime
;
336 temp
.HighPart
= current_ftime
.dwHighDateTime
;
338 retval
= temp
.QuadPart
/ tscale
;
344 /* Thread function for a timer thread. */
346 timer_loop (LPVOID arg
)
348 struct itimer_data
*itimer
= (struct itimer_data
*)arg
;
349 int which
= itimer
->type
;
350 int sig
= (which
== ITIMER_REAL
) ? SIGALRM
: SIGPROF
;
351 CRITICAL_SECTION
*crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
352 const DWORD max_sleep
= MAX_SINGLE_SLEEP
* 1000 / TIMER_TICKS_PER_SEC
;
353 HANDLE hth
= (which
== ITIMER_REAL
) ? NULL
: itimer
->caller_thread
;
358 signal_handler handler
;
359 ULONGLONG now
, expire
, reload
;
361 /* Load new values if requested by setitimer. */
362 EnterCriticalSection (crit
);
363 expire
= itimer
->expire
;
364 reload
= itimer
->reload
;
365 LeaveCriticalSection (crit
);
366 if (itimer
->terminate
)
376 if (expire
> (now
= w32_get_timer_time (hth
)))
377 sleep_time
= expire
- now
;
380 /* Don't sleep too long at a time, to be able to see the
381 termination flag without too long a delay. */
382 while (sleep_time
> max_sleep
)
384 if (itimer
->terminate
)
387 EnterCriticalSection (crit
);
388 expire
= itimer
->expire
;
389 LeaveCriticalSection (crit
);
391 (expire
> (now
= w32_get_timer_time (hth
))) ? expire
- now
: 0;
393 if (itimer
->terminate
)
397 Sleep (sleep_time
* 1000 / TIMER_TICKS_PER_SEC
);
398 /* Always sleep past the expiration time, to make sure we
399 never call the handler _before_ the expiration time,
400 always slightly after it. Sleep(5) makes sure we don't
401 hog the CPU by calling 'w32_get_timer_time' with high
402 frequency, and also let other threads work. */
403 while (w32_get_timer_time (hth
) < expire
)
407 EnterCriticalSection (crit
);
408 expire
= itimer
->expire
;
409 LeaveCriticalSection (crit
);
414 handler
= sig_handlers
[sig
];
415 if (!(handler
== SIG_DFL
|| handler
== SIG_IGN
|| handler
== SIG_ERR
)
416 /* FIXME: Don't ignore masked signals. Instead, record that
417 they happened and reissue them when the signal is
419 && !sigismember (&sig_mask
, sig
)
420 /* Simulate masking of SIGALRM and SIGPROF when processing
422 && !fatal_error_in_progress
423 && itimer
->caller_thread
)
425 /* Simulate a signal delivered to the thread which installed
426 the timer, by suspending that thread while the handler
428 HANDLE th
= itimer
->caller_thread
;
429 DWORD result
= SuspendThread (th
);
431 if (result
== (DWORD
)-1)
438 /* Update expiration time and loop. */
439 EnterCriticalSection (crit
);
440 expire
= itimer
->expire
;
443 LeaveCriticalSection (crit
);
446 reload
= itimer
->reload
;
449 now
= w32_get_timer_time (hth
);
452 ULONGLONG lag
= now
- expire
;
454 /* If we missed some opportunities (presumably while
455 sleeping or while the signal handler ran), skip
458 expire
= now
- (lag
% reload
);
464 expire
= 0; /* become idle */
465 itimer
->expire
= expire
;
466 LeaveCriticalSection (crit
);
472 stop_timer_thread (int which
)
474 struct itimer_data
*itimer
=
475 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
477 DWORD err
, exit_code
= 255;
480 /* Signal the thread that it should terminate. */
481 itimer
->terminate
= 1;
483 if (itimer
->timer_thread
== NULL
)
486 /* Wait for the timer thread to terminate voluntarily, then kill it
487 if it doesn't. This loop waits twice more than the maximum
488 amount of time a timer thread sleeps, see above. */
489 for (i
= 0; i
< MAX_SINGLE_SLEEP
/ 5; i
++)
491 if (!((status
= GetExitCodeThread (itimer
->timer_thread
, &exit_code
))
492 && exit_code
== STILL_ACTIVE
))
496 if ((status
== FALSE
&& (err
= GetLastError ()) == ERROR_INVALID_HANDLE
)
497 || exit_code
== STILL_ACTIVE
)
499 if (!(status
== FALSE
&& err
== ERROR_INVALID_HANDLE
))
500 TerminateThread (itimer
->timer_thread
, 0);
504 CloseHandle (itimer
->timer_thread
);
505 itimer
->timer_thread
= NULL
;
506 if (itimer
->caller_thread
)
508 CloseHandle (itimer
->caller_thread
);
509 itimer
->caller_thread
= NULL
;
513 /* This is called at shutdown time from term_ntproc. */
517 if (real_itimer
.timer_thread
)
518 stop_timer_thread (ITIMER_REAL
);
519 if (prof_itimer
.timer_thread
)
520 stop_timer_thread (ITIMER_PROF
);
522 /* We are going to delete the critical sections, so timers cannot
526 DeleteCriticalSection (&crit_real
);
527 DeleteCriticalSection (&crit_prof
);
528 DeleteCriticalSection (&crit_sig
);
531 /* This is called at initialization time from init_ntproc. */
535 /* GetThreadTimes is not available on all versions of Windows, so
536 need to probe for its availability dynamically, and call it
537 through a pointer. */
538 s_pfn_Get_Thread_Times
= NULL
; /* in case dumped Emacs comes with a value */
539 if (os_subtype
!= OS_9X
)
540 s_pfn_Get_Thread_Times
=
541 (GetThreadTimes_Proc
)GetProcAddress (GetModuleHandle ("kernel32.dll"),
544 /* Make sure we start with zeroed out itimer structures, since
545 dumping may have left there traces of threads long dead. */
546 memset (&real_itimer
, 0, sizeof real_itimer
);
547 memset (&prof_itimer
, 0, sizeof prof_itimer
);
549 InitializeCriticalSection (&crit_real
);
550 InitializeCriticalSection (&crit_prof
);
551 InitializeCriticalSection (&crit_sig
);
557 start_timer_thread (int which
)
561 struct itimer_data
*itimer
=
562 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
564 if (itimer
->timer_thread
565 && GetExitCodeThread (itimer
->timer_thread
, &exit_code
)
566 && exit_code
== STILL_ACTIVE
)
569 /* Clean up after possibly exited thread. */
570 if (itimer
->timer_thread
)
572 CloseHandle (itimer
->timer_thread
);
573 itimer
->timer_thread
= NULL
;
575 if (itimer
->caller_thread
)
577 CloseHandle (itimer
->caller_thread
);
578 itimer
->caller_thread
= NULL
;
581 /* Start a new thread. */
582 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
583 GetCurrentProcess (), &th
, 0, FALSE
,
584 DUPLICATE_SAME_ACCESS
))
589 itimer
->terminate
= 0;
590 itimer
->type
= which
;
591 itimer
->caller_thread
= th
;
592 /* Request that no more than 64KB of stack be reserved for this
593 thread, to avoid reserving too much memory, which would get in
594 the way of threads we start to wait for subprocesses. See also
596 itimer
->timer_thread
= CreateThread (NULL
, 64 * 1024, timer_loop
,
597 (void *)itimer
, 0x00010000, NULL
);
599 if (!itimer
->timer_thread
)
601 CloseHandle (itimer
->caller_thread
);
602 itimer
->caller_thread
= NULL
;
607 /* This is needed to make sure that the timer thread running for
608 profiling gets CPU as soon as the Sleep call terminates. */
609 if (which
== ITIMER_PROF
)
610 SetThreadPriority (itimer
->timer_thread
, THREAD_PRIORITY_TIME_CRITICAL
);
615 /* Most of the code of getitimer and setitimer (but not of their
616 subroutines) was shamelessly stolen from itimer.c in the DJGPP
617 library, see www.delorie.com/djgpp. */
619 getitimer (int which
, struct itimerval
*value
)
621 volatile ULONGLONG
*t_expire
;
622 volatile ULONGLONG
*t_reload
;
623 ULONGLONG expire
, reload
;
625 CRITICAL_SECTION
*crit
;
626 struct itimer_data
*itimer
;
637 if (which
!= ITIMER_REAL
&& which
!= ITIMER_PROF
)
643 itimer
= (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
645 ticks_now
= w32_get_timer_time ((which
== ITIMER_REAL
)
647 : GetCurrentThread ());
649 t_expire
= &itimer
->expire
;
650 t_reload
= &itimer
->reload
;
651 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
653 EnterCriticalSection (crit
);
656 LeaveCriticalSection (crit
);
661 value
->it_value
.tv_sec
= expire
/ TIMER_TICKS_PER_SEC
;
663 (expire
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
664 value
->it_value
.tv_usec
= usecs
;
665 value
->it_interval
.tv_sec
= reload
/ TIMER_TICKS_PER_SEC
;
667 (reload
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
668 value
->it_interval
.tv_usec
= usecs
;
674 setitimer(int which
, struct itimerval
*value
, struct itimerval
*ovalue
)
676 volatile ULONGLONG
*t_expire
, *t_reload
;
677 ULONGLONG expire
, reload
, expire_old
, reload_old
;
679 CRITICAL_SECTION
*crit
;
680 struct itimerval tem
, *ptem
;
685 /* Posix systems expect timer values smaller than the resolution of
686 the system clock be rounded up to the clock resolution. First
687 time we are called, measure the clock tick resolution. */
692 for (t1
= w32_get_timer_time (NULL
);
693 (t2
= w32_get_timer_time (NULL
)) == t1
; )
695 clocks_min
= t2
- t1
;
703 if (getitimer (which
, ptem
)) /* also sets ticks_now */
704 return -1; /* errno already set */
707 (which
== ITIMER_REAL
) ? &real_itimer
.expire
: &prof_itimer
.expire
;
709 (which
== ITIMER_REAL
) ? &real_itimer
.reload
: &prof_itimer
.reload
;
711 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
714 || (value
->it_value
.tv_sec
== 0 && value
->it_value
.tv_usec
== 0))
716 EnterCriticalSection (crit
);
717 /* Disable the timer. */
720 LeaveCriticalSection (crit
);
724 reload
= value
->it_interval
.tv_sec
* TIMER_TICKS_PER_SEC
;
726 usecs
= value
->it_interval
.tv_usec
;
727 if (value
->it_interval
.tv_sec
== 0
728 && usecs
&& usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
732 usecs
*= TIMER_TICKS_PER_SEC
;
733 reload
+= usecs
/ 1000000;
736 expire
= value
->it_value
.tv_sec
* TIMER_TICKS_PER_SEC
;
737 usecs
= value
->it_value
.tv_usec
;
738 if (value
->it_value
.tv_sec
== 0
739 && usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
743 usecs
*= TIMER_TICKS_PER_SEC
;
744 expire
+= usecs
/ 1000000;
749 EnterCriticalSection (crit
);
750 expire_old
= *t_expire
;
751 reload_old
= *t_reload
;
752 if (!(expire
== expire_old
&& reload
== reload_old
))
757 LeaveCriticalSection (crit
);
759 return start_timer_thread (which
);
765 #ifdef HAVE_SETITIMER
766 struct itimerval new_values
, old_values
;
768 new_values
.it_value
.tv_sec
= seconds
;
769 new_values
.it_value
.tv_usec
= 0;
770 new_values
.it_interval
.tv_sec
= new_values
.it_interval
.tv_usec
= 0;
772 if (setitimer (ITIMER_REAL
, &new_values
, &old_values
) < 0)
774 return old_values
.it_value
.tv_sec
;
780 /* Defined in <process.h> which conflicts with the local copy */
783 /* Child process management list. */
784 int child_proc_count
= 0;
785 child_process child_procs
[ MAX_CHILDREN
];
786 child_process
*dead_child
= NULL
;
788 static DWORD WINAPI
reader_thread (void *arg
);
790 /* Find an unused process slot. */
797 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
798 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
800 if (child_proc_count
== MAX_CHILDREN
)
803 child_process
*dead_cp
= NULL
;
805 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
806 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
807 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
)
811 if (!GetExitCodeProcess (cp
->procinfo
.hProcess
, &status
))
813 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
814 GetLastError (), cp
->procinfo
.dwProcessId
));
815 status
= STILL_ACTIVE
;
817 if (status
!= STILL_ACTIVE
818 || WaitForSingleObject (cp
->procinfo
.hProcess
, 0) == WAIT_OBJECT_0
)
820 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
821 cp
->procinfo
.dwProcessId
, cp
->fd
));
822 CloseHandle (cp
->procinfo
.hProcess
);
823 cp
->procinfo
.hProcess
= NULL
;
824 CloseHandle (cp
->procinfo
.hThread
);
825 cp
->procinfo
.hThread
= NULL
;
826 /* Free up to 2 dead slots at a time, so that if we
827 have a lot of them, they will eventually all be
828 freed when the tornado ends. */
842 if (child_proc_count
== MAX_CHILDREN
)
844 cp
= &child_procs
[child_proc_count
++];
847 memset (cp
, 0, sizeof (*cp
));
850 cp
->procinfo
.hProcess
= NULL
;
851 cp
->status
= STATUS_READ_ERROR
;
853 /* use manual reset event so that select() will function properly */
854 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
857 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
858 if (cp
->char_consumed
)
860 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
861 It means that the 64K stack we are requesting in the 2nd
862 argument is how much memory should be reserved for the
863 stack. If we don't use this flag, the memory requested
864 by the 2nd argument is the amount actually _committed_,
865 but Windows reserves 8MB of memory for each thread's
866 stack. (The 8MB figure comes from the -stack
867 command-line argument we pass to the linker when building
868 Emacs, but that's because we need a large stack for
869 Emacs's main thread.) Since we request 2GB of reserved
870 memory at startup (see w32heap.c), which is close to the
871 maximum memory available for a 32-bit process on Windows,
872 the 8MB reservation for each thread causes failures in
873 starting subprocesses, because we create a thread running
874 reader_thread for each subprocess. As 8MB of stack is
875 way too much for reader_thread, forcing Windows to
876 reserve less wins the day. */
877 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
888 delete_child (child_process
*cp
)
892 /* Should not be deleting a child that is still needed. */
893 for (i
= 0; i
< MAXDESC
; i
++)
894 if (fd_info
[i
].cp
== cp
)
897 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
900 /* reap thread if necessary */
905 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
907 /* let the thread exit cleanly if possible */
908 cp
->status
= STATUS_READ_ERROR
;
909 SetEvent (cp
->char_consumed
);
911 /* We used to forcibly terminate the thread here, but it
912 is normally unnecessary, and in abnormal cases, the worst that
913 will happen is we have an extra idle thread hanging around
914 waiting for the zombie process. */
915 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
917 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
918 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
919 TerminateThread (cp
->thrd
, 0);
923 CloseHandle (cp
->thrd
);
928 CloseHandle (cp
->char_avail
);
929 cp
->char_avail
= NULL
;
931 if (cp
->char_consumed
)
933 CloseHandle (cp
->char_consumed
);
934 cp
->char_consumed
= NULL
;
937 /* update child_proc_count (highest numbered slot in use plus one) */
938 if (cp
== child_procs
+ child_proc_count
- 1)
940 for (i
= child_proc_count
-1; i
>= 0; i
--)
941 if (CHILD_ACTIVE (&child_procs
[i
])
942 || child_procs
[i
].procinfo
.hProcess
!= NULL
)
944 child_proc_count
= i
+ 1;
949 child_proc_count
= 0;
952 /* Find a child by pid. */
953 static child_process
*
954 find_child_pid (DWORD pid
)
958 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
959 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
!= NULL
)
966 /* Thread proc for child process and socket reader threads. Each thread
967 is normally blocked until woken by select() to check for input by
968 reading one char. When the read completes, char_avail is signaled
969 to wake up the select emulator and the thread blocks itself again. */
971 reader_thread (void *arg
)
976 cp
= (child_process
*)arg
;
978 /* We have to wait for the go-ahead before we can start */
980 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
988 if (fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
989 rc
= _sys_wait_accept (cp
->fd
);
991 rc
= _sys_read_ahead (cp
->fd
);
993 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
&& cp
->fd
>= 0)
995 /* Somebody already called delete_child on this child, since
996 only delete_child zeroes out cp->char_avail. This means
997 no one will read from cp->fd and will not set the
998 FILE_AT_EOF flag, therefore preventing sys_select from
999 noticing that the process died. Set the flag here
1001 fd_info
[cp
->fd
].flags
|= FILE_AT_EOF
;
1004 /* The name char_avail is a misnomer - it really just means the
1005 read-ahead has completed, whether successfully or not. */
1006 if (!SetEvent (cp
->char_avail
))
1008 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1009 (DWORD_PTR
)cp
->char_avail
, GetLastError (),
1014 if (rc
== STATUS_READ_ERROR
)
1017 /* If the read died, the child has died so let the thread die */
1018 if (rc
== STATUS_READ_FAILED
)
1021 /* Wait until our input is acknowledged before reading again */
1022 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
1024 DebPrint (("reader_thread.WaitForSingleObject failed with "
1025 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
1032 /* To avoid Emacs changing directory, we just record here the directory
1033 the new process should start in. This is set just before calling
1034 sys_spawnve, and is not generally valid at any other time. */
1035 static char * process_dir
;
1038 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
1039 int * pPid
, child_process
*cp
)
1042 SECURITY_ATTRIBUTES sec_attrs
;
1044 SECURITY_DESCRIPTOR sec_desc
;
1047 char dir
[ MAXPATHLEN
];
1049 if (cp
== NULL
) emacs_abort ();
1051 memset (&start
, 0, sizeof (start
));
1052 start
.cb
= sizeof (start
);
1055 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1056 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1058 start
.dwFlags
= STARTF_USESTDHANDLES
;
1059 start
.wShowWindow
= SW_HIDE
;
1061 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1062 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1063 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1064 #endif /* HAVE_NTGUI */
1067 /* Explicitly specify no security */
1068 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1070 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1073 sec_attrs
.nLength
= sizeof (sec_attrs
);
1074 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1075 sec_attrs
.bInheritHandle
= FALSE
;
1077 strcpy (dir
, process_dir
);
1078 unixtodos_filename (dir
);
1080 flags
= (!NILP (Vw32_start_process_share_console
)
1081 ? CREATE_NEW_PROCESS_GROUP
1082 : CREATE_NEW_CONSOLE
);
1083 if (NILP (Vw32_start_process_inherit_error_mode
))
1084 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1085 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1086 flags
, env
, dir
, &start
, &cp
->procinfo
))
1089 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1091 /* Hack for Windows 95, which assigns large (ie negative) pids */
1095 /* pid must fit in a Lisp_Int */
1096 cp
->pid
= cp
->pid
& INTMASK
;
1103 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1107 /* create_child doesn't know what emacs' file handle will be for waiting
1108 on output from the child, so we need to make this additional call
1109 to register the handle with the process
1110 This way the select emulator knows how to match file handles with
1111 entries in child_procs. */
1113 register_child (int pid
, int fd
)
1117 cp
= find_child_pid (pid
);
1120 DebPrint (("register_child unable to find pid %lu\n", pid
));
1125 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1130 /* thread is initially blocked until select is called; set status so
1131 that select will release thread */
1132 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1134 /* attach child_process to fd_info */
1135 if (fd_info
[fd
].cp
!= NULL
)
1137 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1141 fd_info
[fd
].cp
= cp
;
1144 /* When a process dies its pipe will break so the reader thread will
1145 signal failure to the select emulator.
1146 The select emulator then calls this routine to clean up.
1147 Since the thread signaled failure we can assume it is exiting. */
1149 reap_subprocess (child_process
*cp
)
1151 if (cp
->procinfo
.hProcess
)
1153 /* Reap the process */
1155 /* Process should have already died before we are called. */
1156 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1157 DebPrint (("reap_subprocess: child fpr fd %d has not died yet!", cp
->fd
));
1159 CloseHandle (cp
->procinfo
.hProcess
);
1160 cp
->procinfo
.hProcess
= NULL
;
1161 CloseHandle (cp
->procinfo
.hThread
);
1162 cp
->procinfo
.hThread
= NULL
;
1165 /* For asynchronous children, the child_proc resources will be freed
1166 when the last pipe read descriptor is closed; for synchronous
1167 children, we must explicitly free the resources now because
1168 register_child has not been called. */
1173 /* Reset the flag set by reader_thread. */
1174 fd_info
[cp
->fd
].flags
&= ~FILE_AT_EOF
;
1178 /* Wait for any of our existing child processes to die
1179 When it does, close its handle
1180 Return the pid and fill in the status if non-NULL. */
1183 sys_wait (int *status
)
1185 DWORD active
, retval
;
1188 child_process
*cp
, *cps
[MAX_CHILDREN
];
1189 HANDLE wait_hnd
[MAX_CHILDREN
];
1192 if (dead_child
!= NULL
)
1194 /* We want to wait for a specific child */
1195 wait_hnd
[nh
] = dead_child
->procinfo
.hProcess
;
1196 cps
[nh
] = dead_child
;
1197 if (!wait_hnd
[nh
]) emacs_abort ();
1204 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1205 /* some child_procs might be sockets; ignore them */
1206 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1207 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1209 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1217 /* Nothing to wait on, so fail */
1224 /* Check for quit about once a second. */
1226 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, 1000);
1227 } while (active
== WAIT_TIMEOUT
);
1229 if (active
== WAIT_FAILED
)
1234 else if (active
>= WAIT_OBJECT_0
1235 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1237 active
-= WAIT_OBJECT_0
;
1239 else if (active
>= WAIT_ABANDONED_0
1240 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1242 active
-= WAIT_ABANDONED_0
;
1248 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1250 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1254 if (retval
== STILL_ACTIVE
)
1256 /* Should never happen */
1257 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1262 /* Massage the exit code from the process to match the format expected
1263 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1264 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1266 if (retval
== STATUS_CONTROL_C_EXIT
)
1274 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1281 else if (synch_process_alive
)
1283 synch_process_alive
= 0;
1285 /* Report the status of the synchronous process. */
1286 if (WIFEXITED (retval
))
1287 synch_process_retcode
= WEXITSTATUS (retval
);
1288 else if (WIFSIGNALED (retval
))
1290 int code
= WTERMSIG (retval
);
1291 const char *signame
;
1293 synchronize_system_messages_locale ();
1294 signame
= strsignal (code
);
1297 signame
= "unknown";
1299 synch_process_death
= signame
;
1302 reap_subprocess (cp
);
1305 reap_subprocess (cp
);
1310 /* Old versions of w32api headers don't have separate 32-bit and
1311 64-bit defines, but the one they have matches the 32-bit variety. */
1312 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1313 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1314 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1318 w32_executable_type (char * filename
,
1320 int * is_cygnus_app
,
1323 file_data executable
;
1326 /* Default values in case we can't tell for sure. */
1327 *is_dos_app
= FALSE
;
1328 *is_cygnus_app
= FALSE
;
1329 *is_gui_app
= FALSE
;
1331 if (!open_input_file (&executable
, filename
))
1334 p
= strrchr (filename
, '.');
1336 /* We can only identify DOS .com programs from the extension. */
1337 if (p
&& xstrcasecmp (p
, ".com") == 0)
1339 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1340 || xstrcasecmp (p
, ".cmd") == 0))
1342 /* A DOS shell script - it appears that CreateProcess is happy to
1343 accept this (somewhat surprisingly); presumably it looks at
1344 COMSPEC to determine what executable to actually invoke.
1345 Therefore, we have to do the same here as well. */
1346 /* Actually, I think it uses the program association for that
1347 extension, which is defined in the registry. */
1348 p
= egetenv ("COMSPEC");
1350 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
1354 /* Look for DOS .exe signature - if found, we must also check that
1355 it isn't really a 16- or 32-bit Windows exe, since both formats
1356 start with a DOS program stub. Note that 16-bit Windows
1357 executables use the OS/2 1.x format. */
1359 IMAGE_DOS_HEADER
* dos_header
;
1360 IMAGE_NT_HEADERS
* nt_header
;
1362 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1363 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1366 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1368 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1370 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1373 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1374 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1378 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1380 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1381 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1383 /* Ensure we are using the 32 bit structure. */
1384 IMAGE_OPTIONAL_HEADER32
*opt
1385 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1386 data_dir
= opt
->DataDirectory
;
1387 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1389 /* MingW 3.12 has the required 64 bit structs, but in case older
1390 versions don't, only check 64 bit exes if we know how. */
1391 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1392 else if (nt_header
->OptionalHeader
.Magic
1393 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1395 IMAGE_OPTIONAL_HEADER64
*opt
1396 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1397 data_dir
= opt
->DataDirectory
;
1398 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1403 /* Look for cygwin.dll in DLL import list. */
1404 IMAGE_DATA_DIRECTORY import_dir
=
1405 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1406 IMAGE_IMPORT_DESCRIPTOR
* imports
;
1407 IMAGE_SECTION_HEADER
* section
;
1409 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
1410 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
1413 for ( ; imports
->Name
; imports
++)
1415 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1418 /* The exact name of the cygwin dll has changed with
1419 various releases, but hopefully this will be reasonably
1421 if (strncmp (dllname
, "cygwin", 6) == 0)
1423 *is_cygnus_app
= TRUE
;
1432 close_file_data (&executable
);
1436 compare_env (const void *strp1
, const void *strp2
)
1438 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1440 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1442 /* Sort order in command.com/cmd.exe is based on uppercasing
1443 names, so do the same here. */
1444 if (toupper (*str1
) > toupper (*str2
))
1446 else if (toupper (*str1
) < toupper (*str2
))
1451 if (*str1
== '=' && *str2
== '=')
1453 else if (*str1
== '=')
1460 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1462 char **optr
, **nptr
;
1474 num
+= optr
- envp2
;
1476 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1481 /* When a new child process is created we need to register it in our list,
1482 so intercept spawn requests. */
1484 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1486 Lisp_Object program
, full
;
1487 char *cmdline
, *env
, *parg
, **targ
;
1491 int is_dos_app
, is_cygnus_app
, is_gui_app
;
1493 /* We pass our process ID to our children by setting up an environment
1494 variable in their environment. */
1495 char ppid_env_var_buffer
[64];
1496 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1497 /* These are the characters that cause an argument to need quoting.
1498 Arguments with whitespace characters need quoting to prevent the
1499 argument being split into two or more. Arguments with wildcards
1500 are also quoted, for consistency with posix platforms, where wildcards
1501 are not expanded if we run the program directly without a shell.
1502 Some extra whitespace characters need quoting in Cygwin programs,
1503 so this list is conditionally modified below. */
1504 char *sepchars
= " \t*?";
1505 /* This is for native w32 apps; modified below for Cygwin apps. */
1506 char escape_char
= '\\';
1508 /* We don't care about the other modes */
1509 if (mode
!= _P_NOWAIT
)
1515 /* Handle executable names without an executable suffix. */
1516 program
= build_string (cmdname
);
1517 if (NILP (Ffile_executable_p (program
)))
1519 struct gcpro gcpro1
;
1523 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
1533 /* make sure argv[0] and cmdname are both in DOS format */
1534 cmdname
= SDATA (program
);
1535 unixtodos_filename (cmdname
);
1538 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1539 executable that is implicitly linked to the Cygnus dll (implying it
1540 was compiled with the Cygnus GNU toolchain and hence relies on
1541 cygwin.dll to parse the command line - we use this to decide how to
1542 escape quote chars in command line args that must be quoted).
1544 Also determine whether it is a GUI app, so that we don't hide its
1545 initial window unless specifically requested. */
1546 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
1548 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1549 application to start it by specifying the helper app as cmdname,
1550 while leaving the real app name as argv[0]. */
1553 cmdname
= alloca (MAXPATHLEN
);
1554 if (egetenv ("CMDPROXY"))
1555 strcpy (cmdname
, egetenv ("CMDPROXY"));
1558 strcpy (cmdname
, SDATA (Vinvocation_directory
));
1559 strcat (cmdname
, "cmdproxy.exe");
1561 unixtodos_filename (cmdname
);
1564 /* we have to do some conjuring here to put argv and envp into the
1565 form CreateProcess wants... argv needs to be a space separated/null
1566 terminated list of parameters, and envp is a null
1567 separated/double-null terminated list of parameters.
1569 Additionally, zero-length args and args containing whitespace or
1570 quote chars need to be wrapped in double quotes - for this to work,
1571 embedded quotes need to be escaped as well. The aim is to ensure
1572 the child process reconstructs the argv array we start with
1573 exactly, so we treat quotes at the beginning and end of arguments
1576 The w32 GNU-based library from Cygnus doubles quotes to escape
1577 them, while MSVC uses backslash for escaping. (Actually the MSVC
1578 startup code does attempt to recognize doubled quotes and accept
1579 them, but gets it wrong and ends up requiring three quotes to get a
1580 single embedded quote!) So by default we decide whether to use
1581 quote or backslash as the escape character based on whether the
1582 binary is apparently a Cygnus compiled app.
1584 Note that using backslash to escape embedded quotes requires
1585 additional special handling if an embedded quote is already
1586 preceded by backslash, or if an arg requiring quoting ends with
1587 backslash. In such cases, the run of escape characters needs to be
1588 doubled. For consistency, we apply this special handling as long
1589 as the escape character is not quote.
1591 Since we have no idea how large argv and envp are likely to be we
1592 figure out list lengths on the fly and allocate them. */
1594 if (!NILP (Vw32_quote_process_args
))
1597 /* Override escape char by binding w32-quote-process-args to
1598 desired character, or use t for auto-selection. */
1599 if (INTEGERP (Vw32_quote_process_args
))
1600 escape_char
= XINT (Vw32_quote_process_args
);
1602 escape_char
= is_cygnus_app
? '"' : '\\';
1605 /* Cygwin apps needs quoting a bit more often. */
1606 if (escape_char
== '"')
1607 sepchars
= "\r\n\t\f '";
1615 int need_quotes
= 0;
1616 int escape_char_run
= 0;
1622 if (escape_char
== '"' && *p
== '\\')
1623 /* If it's a Cygwin app, \ needs to be escaped. */
1627 /* allow for embedded quotes to be escaped */
1630 /* handle the case where the embedded quote is already escaped */
1631 if (escape_char_run
> 0)
1633 /* To preserve the arg exactly, we need to double the
1634 preceding escape characters (plus adding one to
1635 escape the quote character itself). */
1636 arglen
+= escape_char_run
;
1639 else if (strchr (sepchars
, *p
) != NULL
)
1644 if (*p
== escape_char
&& escape_char
!= '"')
1647 escape_char_run
= 0;
1652 /* handle the case where the arg ends with an escape char - we
1653 must not let the enclosing quote be escaped. */
1654 if (escape_char_run
> 0)
1655 arglen
+= escape_char_run
;
1657 arglen
+= strlen (*targ
++) + 1;
1659 cmdline
= alloca (arglen
);
1665 int need_quotes
= 0;
1673 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1678 int escape_char_run
= 0;
1684 last
= p
+ strlen (p
) - 1;
1687 /* This version does not escape quotes if they occur at the
1688 beginning or end of the arg - this could lead to incorrect
1689 behavior when the arg itself represents a command line
1690 containing quoted args. I believe this was originally done
1691 as a hack to make some things work, before
1692 `w32-quote-process-args' was added. */
1695 if (*p
== '"' && p
> first
&& p
< last
)
1696 *parg
++ = escape_char
; /* escape embedded quotes */
1704 /* double preceding escape chars if any */
1705 while (escape_char_run
> 0)
1707 *parg
++ = escape_char
;
1710 /* escape all quote chars, even at beginning or end */
1711 *parg
++ = escape_char
;
1713 else if (escape_char
== '"' && *p
== '\\')
1717 if (*p
== escape_char
&& escape_char
!= '"')
1720 escape_char_run
= 0;
1722 /* double escape chars before enclosing quote */
1723 while (escape_char_run
> 0)
1725 *parg
++ = escape_char
;
1733 strcpy (parg
, *targ
);
1734 parg
+= strlen (*targ
);
1744 numenv
= 1; /* for end null */
1747 arglen
+= strlen (*targ
++) + 1;
1750 /* extra env vars... */
1751 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
1752 GetCurrentProcessId ());
1753 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1756 /* merge env passed in and extra env into one, and sort it. */
1757 targ
= (char **) alloca (numenv
* sizeof (char *));
1758 merge_and_sort_env (envp
, extra_env
, targ
);
1760 /* concatenate env entries. */
1761 env
= alloca (arglen
);
1765 strcpy (parg
, *targ
);
1766 parg
+= strlen (*targ
++);
1779 /* Now create the process. */
1780 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1790 /* Emulate the select call
1791 Wait for available input on any of the given rfds, or timeout if
1792 a timeout is given and no input is detected
1793 wfds and efds are not supported and must be NULL.
1795 For simplicity, we detect the death of child processes here and
1796 synchronously call the SIGCHLD handler. Since it is possible for
1797 children to be created without a corresponding pipe handle from which
1798 to read output, we wait separately on the process handles as well as
1799 the char_avail events for each process pipe. We only call
1800 wait/reap_process when the process actually terminates.
1802 To reduce the number of places in which Emacs can be hung such that
1803 C-g is not able to interrupt it, we always wait on interrupt_handle
1804 (which is signaled by the input thread when C-g is detected). If we
1805 detect that we were woken up by C-g, we return -1 with errno set to
1806 EINTR as on Unix. */
1808 /* From w32console.c */
1809 extern HANDLE keyboard_handle
;
1811 /* From w32xfns.c */
1812 extern HANDLE interrupt_handle
;
1814 /* From process.c */
1815 extern int proc_buffered_char
[];
1818 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1819 EMACS_TIME
*timeout
, void *ignored
)
1822 DWORD timeout_ms
, start_time
;
1825 child_process
*cp
, *cps
[MAX_CHILDREN
];
1826 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1827 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1830 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
1832 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1833 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1839 /* Otherwise, we only handle rfds, so fail otherwise. */
1840 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1850 /* Always wait on interrupt_handle, to detect C-g (quit). */
1851 wait_hnd
[0] = interrupt_handle
;
1854 /* Build a list of pipe handles to wait on. */
1856 for (i
= 0; i
< nfds
; i
++)
1857 if (FD_ISSET (i
, &orfds
))
1861 if (keyboard_handle
)
1863 /* Handle stdin specially */
1864 wait_hnd
[nh
] = keyboard_handle
;
1869 /* Check for any emacs-generated input in the queue since
1870 it won't be detected in the wait */
1871 if (detect_input_pending ())
1879 /* Child process and socket input */
1883 int current_status
= cp
->status
;
1885 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1887 /* Tell reader thread which file handle to use. */
1889 /* Wake up the reader thread for this process */
1890 cp
->status
= STATUS_READ_READY
;
1891 if (!SetEvent (cp
->char_consumed
))
1892 DebPrint (("nt_select.SetEvent failed with "
1893 "%lu for fd %ld\n", GetLastError (), i
));
1896 #ifdef CHECK_INTERLOCK
1897 /* slightly crude cross-checking of interlock between threads */
1899 current_status
= cp
->status
;
1900 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1902 /* char_avail has been signaled, so status (which may
1903 have changed) should indicate read has completed
1904 but has not been acknowledged. */
1905 current_status
= cp
->status
;
1906 if (current_status
!= STATUS_READ_SUCCEEDED
1907 && current_status
!= STATUS_READ_FAILED
)
1908 DebPrint (("char_avail set, but read not completed: status %d\n",
1913 /* char_avail has not been signaled, so status should
1914 indicate that read is in progress; small possibility
1915 that read has completed but event wasn't yet signaled
1916 when we tested it (because a context switch occurred
1917 or if running on separate CPUs). */
1918 if (current_status
!= STATUS_READ_READY
1919 && current_status
!= STATUS_READ_IN_PROGRESS
1920 && current_status
!= STATUS_READ_SUCCEEDED
1921 && current_status
!= STATUS_READ_FAILED
)
1922 DebPrint (("char_avail reset, but read status is bad: %d\n",
1926 wait_hnd
[nh
] = cp
->char_avail
;
1928 if (!wait_hnd
[nh
]) emacs_abort ();
1931 DebPrint (("select waiting on child %d fd %d\n",
1932 cp
-child_procs
, i
));
1937 /* Unable to find something to wait on for this fd, skip */
1939 /* Note that this is not a fatal error, and can in fact
1940 happen in unusual circumstances. Specifically, if
1941 sys_spawnve fails, eg. because the program doesn't
1942 exist, and debug-on-error is t so Fsignal invokes a
1943 nested input loop, then the process output pipe is
1944 still included in input_wait_mask with no child_proc
1945 associated with it. (It is removed when the debugger
1946 exits the nested input loop and the error is thrown.) */
1948 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
1954 /* Add handles of child processes. */
1956 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1957 /* Some child_procs might be sockets; ignore them. Also some
1958 children may have died already, but we haven't finished reading
1959 the process output; ignore them too. */
1960 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
)
1962 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
1963 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1966 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
1971 /* Nothing to look for, so we didn't find anything */
1979 start_time
= GetTickCount ();
1981 /* Wait for input or child death to be signaled. If user input is
1982 allowed, then also accept window messages. */
1983 if (FD_ISSET (0, &orfds
))
1984 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
1987 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
1989 if (active
== WAIT_FAILED
)
1991 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
1992 nh
+ nc
, timeout_ms
, GetLastError ()));
1993 /* don't return EBADF - this causes wait_reading_process_output to
1994 abort; WAIT_FAILED is returned when single-stepping under
1995 Windows 95 after switching thread focus in debugger, and
1996 possibly at other times. */
2000 else if (active
== WAIT_TIMEOUT
)
2004 else if (active
>= WAIT_OBJECT_0
2005 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
2007 active
-= WAIT_OBJECT_0
;
2009 else if (active
>= WAIT_ABANDONED_0
2010 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
2012 active
-= WAIT_ABANDONED_0
;
2017 /* Loop over all handles after active (now officially documented as
2018 being the first signaled handle in the array). We do this to
2019 ensure fairness, so that all channels with data available will be
2020 processed - otherwise higher numbered channels could be starved. */
2023 if (active
== nh
+ nc
)
2025 /* There are messages in the lisp thread's queue; we must
2026 drain the queue now to ensure they are processed promptly,
2027 because if we don't do so, we will not be woken again until
2028 further messages arrive.
2030 NB. If ever we allow window message procedures to callback
2031 into lisp, we will need to ensure messages are dispatched
2032 at a safe time for lisp code to be run (*), and we may also
2033 want to provide some hooks in the dispatch loop to cater
2034 for modeless dialogs created by lisp (ie. to register
2035 window handles to pass to IsDialogMessage).
2037 (*) Note that MsgWaitForMultipleObjects above is an
2038 internal dispatch point for messages that are sent to
2039 windows created by this thread. */
2040 drain_message_queue ();
2042 else if (active
>= nh
)
2044 cp
= cps
[active
- nh
];
2046 /* We cannot always signal SIGCHLD immediately; if we have not
2047 finished reading the process output, we must delay sending
2048 SIGCHLD until we do. */
2050 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
2051 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
2052 /* SIG_DFL for SIGCHLD is ignore */
2053 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2054 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2057 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2061 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2065 else if (fdindex
[active
] == -1)
2067 /* Quit (C-g) was detected. */
2071 else if (fdindex
[active
] == 0)
2073 /* Keyboard input available */
2079 /* must be a socket or pipe - read ahead should have
2080 completed, either succeeding or failing. */
2081 FD_SET (fdindex
[active
], rfds
);
2085 /* Even though wait_reading_process_output only reads from at most
2086 one channel, we must process all channels here so that we reap
2087 all children that have died. */
2088 while (++active
< nh
+ nc
)
2089 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2091 } while (active
< nh
+ nc
);
2093 /* If no input has arrived and timeout hasn't expired, wait again. */
2096 DWORD elapsed
= GetTickCount () - start_time
;
2098 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2100 if (timeout_ms
!= INFINITE
)
2101 timeout_ms
-= elapsed
;
2102 goto count_children
;
2109 /* Substitute for certain kill () operations */
2111 static BOOL CALLBACK
2112 find_child_console (HWND hwnd
, LPARAM arg
)
2114 child_process
* cp
= (child_process
*) arg
;
2118 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
2119 if (process_id
== cp
->procinfo
.dwProcessId
)
2121 char window_class
[32];
2123 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2124 if (strcmp (window_class
,
2125 (os_subtype
== OS_9X
)
2127 : "ConsoleWindowClass") == 0)
2137 /* Emulate 'kill', but only for other processes. */
2139 sys_kill (int pid
, int sig
)
2143 int need_to_free
= 0;
2146 /* Only handle signals that will result in the process dying */
2147 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
2153 cp
= find_child_pid (pid
);
2156 /* We were passed a PID of something other than our subprocess.
2157 If that is our own PID, we will send to ourself a message to
2158 close the selected frame, which does not necessarily
2159 terminates Emacs. But then we are not supposed to call
2160 sys_kill with our own PID. */
2161 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
2162 if (proc_hand
== NULL
)
2171 proc_hand
= cp
->procinfo
.hProcess
;
2172 pid
= cp
->procinfo
.dwProcessId
;
2174 /* Try to locate console window for process. */
2175 EnumWindows (find_child_console
, (LPARAM
) cp
);
2178 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2180 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2182 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2183 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2184 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2185 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2186 HWND foreground_window
;
2188 if (break_scan_code
== 0)
2190 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2191 vk_break_code
= 'C';
2192 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2195 foreground_window
= GetForegroundWindow ();
2196 if (foreground_window
)
2198 /* NT 5.0, and apparently also Windows 98, will not allow
2199 a Window to be set to foreground directly without the
2200 user's involvement. The workaround is to attach
2201 ourselves to the thread that owns the foreground
2202 window, since that is the only thread that can set the
2203 foreground window. */
2204 DWORD foreground_thread
, child_thread
;
2206 GetWindowThreadProcessId (foreground_window
, NULL
);
2207 if (foreground_thread
== GetCurrentThreadId ()
2208 || !AttachThreadInput (GetCurrentThreadId (),
2209 foreground_thread
, TRUE
))
2210 foreground_thread
= 0;
2212 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2213 if (child_thread
== GetCurrentThreadId ()
2214 || !AttachThreadInput (GetCurrentThreadId (),
2215 child_thread
, TRUE
))
2218 /* Set the foreground window to the child. */
2219 if (SetForegroundWindow (cp
->hwnd
))
2221 /* Generate keystrokes as if user had typed Ctrl-Break or
2223 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2224 keybd_event (vk_break_code
, break_scan_code
,
2225 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2226 keybd_event (vk_break_code
, break_scan_code
,
2227 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2228 | KEYEVENTF_KEYUP
, 0);
2229 keybd_event (VK_CONTROL
, control_scan_code
,
2230 KEYEVENTF_KEYUP
, 0);
2232 /* Sleep for a bit to give time for Emacs frame to respond
2233 to focus change events (if Emacs was active app). */
2236 SetForegroundWindow (foreground_window
);
2238 /* Detach from the foreground and child threads now that
2239 the foreground switching is over. */
2240 if (foreground_thread
)
2241 AttachThreadInput (GetCurrentThreadId (),
2242 foreground_thread
, FALSE
);
2244 AttachThreadInput (GetCurrentThreadId (),
2245 child_thread
, FALSE
);
2248 /* Ctrl-Break is NT equivalent of SIGINT. */
2249 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2251 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2252 "for pid %lu\n", GetLastError (), pid
));
2259 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2262 if (os_subtype
== OS_9X
)
2265 Another possibility is to try terminating the VDM out-right by
2266 calling the Shell VxD (id 0x17) V86 interface, function #4
2267 "SHELL_Destroy_VM", ie.
2273 First need to determine the current VM handle, and then arrange for
2274 the shellapi call to be made from the system vm (by using
2275 Switch_VM_and_callback).
2277 Could try to invoke DestroyVM through CallVxD.
2281 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2282 to hang when cmdproxy is used in conjunction with
2283 command.com for an interactive shell. Posting
2284 WM_CLOSE pops up a dialog that, when Yes is selected,
2285 does the same thing. TerminateProcess is also less
2286 than ideal in that subprocesses tend to stick around
2287 until the machine is shutdown, but at least it
2288 doesn't freeze the 16-bit subsystem. */
2289 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2291 if (!TerminateProcess (proc_hand
, 0xff))
2293 DebPrint (("sys_kill.TerminateProcess returned %d "
2294 "for pid %lu\n", GetLastError (), pid
));
2301 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2303 /* Kill the process. On W32 this doesn't kill child processes
2304 so it doesn't work very well for shells which is why it's not
2305 used in every case. */
2306 else if (!TerminateProcess (proc_hand
, 0xff))
2308 DebPrint (("sys_kill.TerminateProcess returned %d "
2309 "for pid %lu\n", GetLastError (), pid
));
2316 CloseHandle (proc_hand
);
2321 /* The following two routines are used to manipulate stdin, stdout, and
2322 stderr of our child processes.
2324 Assuming that in, out, and err are *not* inheritable, we make them
2325 stdin, stdout, and stderr of the child as follows:
2327 - Save the parent's current standard handles.
2328 - Set the std handles to inheritable duplicates of the ones being passed in.
2329 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2330 NT file handle for a crt file descriptor.)
2331 - Spawn the child, which inherits in, out, and err as stdin,
2332 stdout, and stderr. (see Spawnve)
2333 - Close the std handles passed to the child.
2334 - Reset the parent's standard handles to the saved handles.
2335 (see reset_standard_handles)
2336 We assume that the caller closes in, out, and err after calling us. */
2339 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2342 HANDLE newstdin
, newstdout
, newstderr
;
2344 parent
= GetCurrentProcess ();
2346 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2347 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2348 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2350 /* make inheritable copies of the new handles */
2351 if (!DuplicateHandle (parent
,
2352 (HANDLE
) _get_osfhandle (in
),
2357 DUPLICATE_SAME_ACCESS
))
2358 report_file_error ("Duplicating input handle for child", Qnil
);
2360 if (!DuplicateHandle (parent
,
2361 (HANDLE
) _get_osfhandle (out
),
2366 DUPLICATE_SAME_ACCESS
))
2367 report_file_error ("Duplicating output handle for child", Qnil
);
2369 if (!DuplicateHandle (parent
,
2370 (HANDLE
) _get_osfhandle (err
),
2375 DUPLICATE_SAME_ACCESS
))
2376 report_file_error ("Duplicating error handle for child", Qnil
);
2378 /* and store them as our std handles */
2379 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2380 report_file_error ("Changing stdin handle", Qnil
);
2382 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2383 report_file_error ("Changing stdout handle", Qnil
);
2385 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2386 report_file_error ("Changing stderr handle", Qnil
);
2390 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2392 /* close the duplicated handles passed to the child */
2393 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2394 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2395 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2397 /* now restore parent's saved std handles */
2398 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2399 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2400 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2404 set_process_dir (char * dir
)
2409 /* To avoid problems with winsock implementations that work over dial-up
2410 connections causing or requiring a connection to exist while Emacs is
2411 running, Emacs no longer automatically loads winsock on startup if it
2412 is present. Instead, it will be loaded when open-network-stream is
2415 To allow full control over when winsock is loaded, we provide these
2416 two functions to dynamically load and unload winsock. This allows
2417 dial-up users to only be connected when they actually need to use
2421 extern HANDLE winsock_lib
;
2422 extern BOOL
term_winsock (void);
2423 extern BOOL
init_winsock (int load_now
);
2425 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2426 doc
: /* Test for presence of the Windows socket library `winsock'.
2427 Returns non-nil if winsock support is present, nil otherwise.
2429 If the optional argument LOAD-NOW is non-nil, the winsock library is
2430 also loaded immediately if not already loaded. If winsock is loaded,
2431 the winsock local hostname is returned (since this may be different from
2432 the value of `system-name' and should supplant it), otherwise t is
2433 returned to indicate winsock support is present. */)
2434 (Lisp_Object load_now
)
2438 have_winsock
= init_winsock (!NILP (load_now
));
2441 if (winsock_lib
!= NULL
)
2443 /* Return new value for system-name. The best way to do this
2444 is to call init_system_name, saving and restoring the
2445 original value to avoid side-effects. */
2446 Lisp_Object orig_hostname
= Vsystem_name
;
2447 Lisp_Object hostname
;
2449 init_system_name ();
2450 hostname
= Vsystem_name
;
2451 Vsystem_name
= orig_hostname
;
2459 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2461 doc
: /* Unload the Windows socket library `winsock' if loaded.
2462 This is provided to allow dial-up socket connections to be disconnected
2463 when no longer needed. Returns nil without unloading winsock if any
2464 socket connections still exist. */)
2467 return term_winsock () ? Qt
: Qnil
;
2471 /* Some miscellaneous functions that are Windows specific, but not GUI
2472 specific (ie. are applicable in terminal or batch mode as well). */
2474 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2475 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2476 If FILENAME does not exist, return nil.
2477 All path elements in FILENAME are converted to their short names. */)
2478 (Lisp_Object filename
)
2480 char shortname
[MAX_PATH
];
2482 CHECK_STRING (filename
);
2484 /* first expand it. */
2485 filename
= Fexpand_file_name (filename
, Qnil
);
2487 /* luckily, this returns the short version of each element in the path. */
2488 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
2491 dostounix_filename (shortname
);
2493 return build_string (shortname
);
2497 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2499 doc
: /* Return the long file name version of the full path of FILENAME.
2500 If FILENAME does not exist, return nil.
2501 All path elements in FILENAME are converted to their long names. */)
2502 (Lisp_Object filename
)
2504 char longname
[ MAX_PATH
];
2507 CHECK_STRING (filename
);
2509 if (SBYTES (filename
) == 2
2510 && *(SDATA (filename
) + 1) == ':')
2513 /* first expand it. */
2514 filename
= Fexpand_file_name (filename
, Qnil
);
2516 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
2519 dostounix_filename (longname
);
2521 /* If we were passed only a drive, make sure that a slash is not appended
2522 for consistency with directories. Allow for drive mapping via SUBST
2523 in case expand-file-name is ever changed to expand those. */
2524 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2527 return DECODE_FILE (build_string (longname
));
2530 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2531 Sw32_set_process_priority
, 2, 2, 0,
2532 doc
: /* Set the priority of PROCESS to PRIORITY.
2533 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2534 priority of the process whose pid is PROCESS is changed.
2535 PRIORITY should be one of the symbols high, normal, or low;
2536 any other symbol will be interpreted as normal.
2538 If successful, the return value is t, otherwise nil. */)
2539 (Lisp_Object process
, Lisp_Object priority
)
2541 HANDLE proc_handle
= GetCurrentProcess ();
2542 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2543 Lisp_Object result
= Qnil
;
2545 CHECK_SYMBOL (priority
);
2547 if (!NILP (process
))
2552 CHECK_NUMBER (process
);
2554 /* Allow pid to be an internally generated one, or one obtained
2555 externally. This is necessary because real pids on Windows 95 are
2558 pid
= XINT (process
);
2559 cp
= find_child_pid (pid
);
2561 pid
= cp
->procinfo
.dwProcessId
;
2563 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
2566 if (EQ (priority
, Qhigh
))
2567 priority_class
= HIGH_PRIORITY_CLASS
;
2568 else if (EQ (priority
, Qlow
))
2569 priority_class
= IDLE_PRIORITY_CLASS
;
2571 if (proc_handle
!= NULL
)
2573 if (SetPriorityClass (proc_handle
, priority_class
))
2575 if (!NILP (process
))
2576 CloseHandle (proc_handle
);
2582 #ifdef HAVE_LANGINFO_CODESET
2583 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2585 nl_langinfo (nl_item item
)
2587 /* Conversion of Posix item numbers to their Windows equivalents. */
2588 static const LCTYPE w32item
[] = {
2589 LOCALE_IDEFAULTANSICODEPAGE
,
2590 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
2591 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
2592 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
2593 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
2594 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
2595 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
2598 static char *nl_langinfo_buf
= NULL
;
2599 static int nl_langinfo_len
= 0;
2601 if (nl_langinfo_len
<= 0)
2602 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
2604 if (item
< 0 || item
>= _NL_NUM
)
2605 nl_langinfo_buf
[0] = 0;
2608 LCID cloc
= GetThreadLocale ();
2609 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2613 nl_langinfo_buf
[0] = 0;
2616 if (item
== CODESET
)
2618 need_len
+= 2; /* for the "cp" prefix */
2619 if (need_len
< 8) /* for the case we call GetACP */
2622 if (nl_langinfo_len
<= need_len
)
2623 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
2624 nl_langinfo_len
= need_len
);
2625 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2626 nl_langinfo_buf
, nl_langinfo_len
))
2627 nl_langinfo_buf
[0] = 0;
2628 else if (item
== CODESET
)
2630 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
2631 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
2632 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
2635 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
2636 strlen (nl_langinfo_buf
) + 1);
2637 nl_langinfo_buf
[0] = 'c';
2638 nl_langinfo_buf
[1] = 'p';
2643 return nl_langinfo_buf
;
2645 #endif /* HAVE_LANGINFO_CODESET */
2647 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
2648 Sw32_get_locale_info
, 1, 2, 0,
2649 doc
: /* Return information about the Windows locale LCID.
2650 By default, return a three letter locale code which encodes the default
2651 language as the first two characters, and the country or regional variant
2652 as the third letter. For example, ENU refers to `English (United States)',
2653 while ENC means `English (Canadian)'.
2655 If the optional argument LONGFORM is t, the long form of the locale
2656 name is returned, e.g. `English (United States)' instead; if LONGFORM
2657 is a number, it is interpreted as an LCTYPE constant and the corresponding
2658 locale information is returned.
2660 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2661 (Lisp_Object lcid
, Lisp_Object longform
)
2665 char abbrev_name
[32] = { 0 };
2666 char full_name
[256] = { 0 };
2668 CHECK_NUMBER (lcid
);
2670 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2673 if (NILP (longform
))
2675 got_abbrev
= GetLocaleInfo (XINT (lcid
),
2676 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
2677 abbrev_name
, sizeof (abbrev_name
));
2679 return build_string (abbrev_name
);
2681 else if (EQ (longform
, Qt
))
2683 got_full
= GetLocaleInfo (XINT (lcid
),
2684 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
2685 full_name
, sizeof (full_name
));
2687 return DECODE_SYSTEM (build_string (full_name
));
2689 else if (NUMBERP (longform
))
2691 got_full
= GetLocaleInfo (XINT (lcid
),
2693 full_name
, sizeof (full_name
));
2694 /* GetLocaleInfo's return value includes the terminating null
2695 character, when the returned information is a string, whereas
2696 make_unibyte_string needs the string length without the
2697 terminating null. */
2699 return make_unibyte_string (full_name
, got_full
- 1);
2706 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
2707 Sw32_get_current_locale_id
, 0, 0, 0,
2708 doc
: /* Return Windows locale id for current locale setting.
2709 This is a numerical value; use `w32-get-locale-info' to convert to a
2710 human-readable form. */)
2713 return make_number (GetThreadLocale ());
2717 int_from_hex (char * s
)
2720 static char hex
[] = "0123456789abcdefABCDEF";
2723 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
2725 unsigned digit
= p
- hex
;
2728 val
= val
* 16 + digit
;
2734 /* We need to build a global list, since the EnumSystemLocale callback
2735 function isn't given a context pointer. */
2736 Lisp_Object Vw32_valid_locale_ids
;
2738 static BOOL CALLBACK
2739 enum_locale_fn (LPTSTR localeNum
)
2741 DWORD id
= int_from_hex (localeNum
);
2742 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2746 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2747 Sw32_get_valid_locale_ids
, 0, 0, 0,
2748 doc
: /* Return list of all valid Windows locale ids.
2749 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2750 human-readable form. */)
2753 Vw32_valid_locale_ids
= Qnil
;
2755 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2757 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2758 return Vw32_valid_locale_ids
;
2762 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2763 doc
: /* Return Windows locale id for default locale setting.
2764 By default, the system default locale setting is returned; if the optional
2765 parameter USERP is non-nil, the user default locale setting is returned.
2766 This is a numerical value; use `w32-get-locale-info' to convert to a
2767 human-readable form. */)
2771 return make_number (GetSystemDefaultLCID ());
2772 return make_number (GetUserDefaultLCID ());
2776 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2777 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2778 If successful, the new locale id is returned, otherwise nil. */)
2781 CHECK_NUMBER (lcid
);
2783 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2786 if (!SetThreadLocale (XINT (lcid
)))
2789 /* Need to set input thread locale if present. */
2790 if (dwWindowsThreadId
)
2791 /* Reply is not needed. */
2792 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2794 return make_number (GetThreadLocale ());
2798 /* We need to build a global list, since the EnumCodePages callback
2799 function isn't given a context pointer. */
2800 Lisp_Object Vw32_valid_codepages
;
2802 static BOOL CALLBACK
2803 enum_codepage_fn (LPTSTR codepageNum
)
2805 DWORD id
= atoi (codepageNum
);
2806 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2810 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2811 Sw32_get_valid_codepages
, 0, 0, 0,
2812 doc
: /* Return list of all valid Windows codepages. */)
2815 Vw32_valid_codepages
= Qnil
;
2817 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2819 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2820 return Vw32_valid_codepages
;
2824 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2825 Sw32_get_console_codepage
, 0, 0, 0,
2826 doc
: /* Return current Windows codepage for console input. */)
2829 return make_number (GetConsoleCP ());
2833 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2834 Sw32_set_console_codepage
, 1, 1, 0,
2835 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2836 This codepage setting affects keyboard input in tty mode.
2837 If successful, the new CP is returned, otherwise nil. */)
2842 if (!IsValidCodePage (XINT (cp
)))
2845 if (!SetConsoleCP (XINT (cp
)))
2848 return make_number (GetConsoleCP ());
2852 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2853 Sw32_get_console_output_codepage
, 0, 0, 0,
2854 doc
: /* Return current Windows codepage for console output. */)
2857 return make_number (GetConsoleOutputCP ());
2861 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2862 Sw32_set_console_output_codepage
, 1, 1, 0,
2863 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
2864 This codepage setting affects display in tty mode.
2865 If successful, the new CP is returned, otherwise nil. */)
2870 if (!IsValidCodePage (XINT (cp
)))
2873 if (!SetConsoleOutputCP (XINT (cp
)))
2876 return make_number (GetConsoleOutputCP ());
2880 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2881 Sw32_get_codepage_charset
, 1, 1, 0,
2882 doc
: /* Return charset ID corresponding to codepage CP.
2883 Returns nil if the codepage is not valid. */)
2890 if (!IsValidCodePage (XINT (cp
)))
2893 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2894 return make_number (info
.ciCharset
);
2900 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2901 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2902 doc
: /* Return list of Windows keyboard languages and layouts.
2903 The return value is a list of pairs of language id and layout id. */)
2906 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2907 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2908 Lisp_Object obj
= Qnil
;
2910 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2912 while (--num_layouts
>= 0)
2914 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2916 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2917 make_number ((kl
>> 16) & 0xffff)),
2926 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2927 Sw32_get_keyboard_layout
, 0, 0, 0,
2928 doc
: /* Return current Windows keyboard language and layout.
2929 The return value is the cons of the language id and the layout id. */)
2932 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
2934 return Fcons (make_number (kl
& 0xffff),
2935 make_number ((kl
>> 16) & 0xffff));
2939 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
2940 Sw32_set_keyboard_layout
, 1, 1, 0,
2941 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
2942 The keyboard layout setting affects interpretation of keyboard input.
2943 If successful, the new layout id is returned, otherwise nil. */)
2944 (Lisp_Object layout
)
2948 CHECK_CONS (layout
);
2949 CHECK_NUMBER_CAR (layout
);
2950 CHECK_NUMBER_CDR (layout
);
2952 kl
= (XINT (XCAR (layout
)) & 0xffff)
2953 | (XINT (XCDR (layout
)) << 16);
2955 /* Synchronize layout with input thread. */
2956 if (dwWindowsThreadId
)
2958 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
2962 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
2964 if (msg
.wParam
== 0)
2968 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
2971 return Fw32_get_keyboard_layout ();
2976 syms_of_ntproc (void)
2978 DEFSYM (Qhigh
, "high");
2979 DEFSYM (Qlow
, "low");
2981 defsubr (&Sw32_has_winsock
);
2982 defsubr (&Sw32_unload_winsock
);
2984 defsubr (&Sw32_short_file_name
);
2985 defsubr (&Sw32_long_file_name
);
2986 defsubr (&Sw32_set_process_priority
);
2987 defsubr (&Sw32_get_locale_info
);
2988 defsubr (&Sw32_get_current_locale_id
);
2989 defsubr (&Sw32_get_default_locale_id
);
2990 defsubr (&Sw32_get_valid_locale_ids
);
2991 defsubr (&Sw32_set_current_locale
);
2993 defsubr (&Sw32_get_console_codepage
);
2994 defsubr (&Sw32_set_console_codepage
);
2995 defsubr (&Sw32_get_console_output_codepage
);
2996 defsubr (&Sw32_set_console_output_codepage
);
2997 defsubr (&Sw32_get_valid_codepages
);
2998 defsubr (&Sw32_get_codepage_charset
);
3000 defsubr (&Sw32_get_valid_keyboard_layouts
);
3001 defsubr (&Sw32_get_keyboard_layout
);
3002 defsubr (&Sw32_set_keyboard_layout
);
3004 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
3005 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3006 Because Windows does not directly pass argv arrays to child processes,
3007 programs have to reconstruct the argv array by parsing the command
3008 line string. For an argument to contain a space, it must be enclosed
3009 in double quotes or it will be parsed as multiple arguments.
3011 If the value is a character, that character will be used to escape any
3012 quote characters that appear, otherwise a suitable escape character
3013 will be chosen based on the type of the program. */);
3014 Vw32_quote_process_args
= Qt
;
3016 DEFVAR_LISP ("w32-start-process-show-window",
3017 Vw32_start_process_show_window
,
3018 doc
: /* When nil, new child processes hide their windows.
3019 When non-nil, they show their window in the method of their choice.
3020 This variable doesn't affect GUI applications, which will never be hidden. */);
3021 Vw32_start_process_show_window
= Qnil
;
3023 DEFVAR_LISP ("w32-start-process-share-console",
3024 Vw32_start_process_share_console
,
3025 doc
: /* When nil, new child processes are given a new console.
3026 When non-nil, they share the Emacs console; this has the limitation of
3027 allowing only one DOS subprocess to run at a time (whether started directly
3028 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3029 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3030 otherwise respond to interrupts from Emacs. */);
3031 Vw32_start_process_share_console
= Qnil
;
3033 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3034 Vw32_start_process_inherit_error_mode
,
3035 doc
: /* When nil, new child processes revert to the default error mode.
3036 When non-nil, they inherit their error mode setting from Emacs, which stops
3037 them blocking when trying to access unmounted drives etc. */);
3038 Vw32_start_process_inherit_error_mode
= Qt
;
3040 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
3041 doc
: /* Forced delay before reading subprocess output.
3042 This is done to improve the buffering of subprocess output, by
3043 avoiding the inefficiency of frequently reading small amounts of data.
3045 If positive, the value is the number of milliseconds to sleep before
3046 reading the subprocess output. If negative, the magnitude is the number
3047 of time slices to wait (effectively boosting the priority of the child
3048 process temporarily). A value of zero disables waiting entirely. */);
3049 w32_pipe_read_delay
= 50;
3051 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
3052 doc
: /* Non-nil means convert all-upper case file names to lower case.
3053 This applies when performing completions and file name expansion.
3054 Note that the value of this setting also affects remote file names,
3055 so you probably don't want to set to non-nil if you use case-sensitive
3056 filesystems via ange-ftp. */);
3057 Vw32_downcase_file_names
= Qnil
;
3060 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3061 doc
: /* Non-nil means attempt to fake realistic inode values.
3062 This works by hashing the truename of files, and should detect
3063 aliasing between long and short (8.3 DOS) names, but can have
3064 false positives because of hash collisions. Note that determining
3065 the truename of a file can be slow. */);
3066 Vw32_generate_fake_inodes
= Qnil
;
3069 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3070 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3071 This option controls whether to issue additional system calls to determine
3072 accurate link counts, file type, and ownership information. It is more
3073 useful for files on NTFS volumes, where hard links and file security are
3074 supported, than on volumes of the FAT family.
3076 Without these system calls, link count will always be reported as 1 and file
3077 ownership will be attributed to the current user.
3078 The default value `local' means only issue these system calls for files
3079 on local fixed drives. A value of nil means never issue them.
3080 Any other non-nil value means do this even on remote and removable drives
3081 where the performance impact may be noticeable even on modern hardware. */);
3082 Vw32_get_true_file_attributes
= Qlocal
;
3084 staticpro (&Vw32_valid_locale_ids
);
3085 staticpro (&Vw32_valid_codepages
);
3087 /* end of w32proc.c */