1 /* Process support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1992, 1995, 1999-2012 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;
246 setpgid (pid_t pid
, pid_t pgid
)
257 /* Emulations of interval timers.
259 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
261 Implementation: a separate thread is started for each timer type,
262 the thread calls the appropriate signal handler when the timer
263 expires, after stopping the thread which installed the timer. */
266 volatile ULONGLONG expire
;
267 volatile ULONGLONG reload
;
268 volatile int terminate
;
270 HANDLE caller_thread
;
274 static ULONGLONG ticks_now
;
275 static struct itimer_data real_itimer
, prof_itimer
;
276 static ULONGLONG clocks_min
;
277 /* If non-zero, itimers are disabled. Used during shutdown, when we
278 delete the critical sections used by the timer threads. */
279 static int disable_itimers
;
281 static CRITICAL_SECTION crit_real
, crit_prof
;
283 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
284 typedef BOOL (WINAPI
*GetThreadTimes_Proc
) (
286 LPFILETIME lpCreationTime
,
287 LPFILETIME lpExitTime
,
288 LPFILETIME lpKernelTime
,
289 LPFILETIME lpUserTime
);
291 static GetThreadTimes_Proc s_pfn_Get_Thread_Times
;
293 #define MAX_SINGLE_SLEEP 30
294 #define TIMER_TICKS_PER_SEC 1000
296 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
297 to a thread. If THREAD is NULL or an invalid handle, return the
298 current wall-clock time since January 1, 1601 (UTC). Otherwise,
299 return the sum of kernel and user times used by THREAD since it was
300 created, plus its creation time. */
302 w32_get_timer_time (HANDLE thread
)
305 int use_system_time
= 1;
306 /* The functions below return times in 100-ns units. */
307 const int tscale
= 10 * TIMER_TICKS_PER_SEC
;
309 if (thread
&& thread
!= INVALID_HANDLE_VALUE
310 && s_pfn_Get_Thread_Times
!= NULL
)
312 FILETIME creation_ftime
, exit_ftime
, kernel_ftime
, user_ftime
;
313 ULARGE_INTEGER temp_creation
, temp_kernel
, temp_user
;
315 if (s_pfn_Get_Thread_Times (thread
, &creation_ftime
, &exit_ftime
,
316 &kernel_ftime
, &user_ftime
))
319 temp_creation
.LowPart
= creation_ftime
.dwLowDateTime
;
320 temp_creation
.HighPart
= creation_ftime
.dwHighDateTime
;
321 temp_kernel
.LowPart
= kernel_ftime
.dwLowDateTime
;
322 temp_kernel
.HighPart
= kernel_ftime
.dwHighDateTime
;
323 temp_user
.LowPart
= user_ftime
.dwLowDateTime
;
324 temp_user
.HighPart
= user_ftime
.dwHighDateTime
;
326 temp_creation
.QuadPart
/ tscale
+ temp_kernel
.QuadPart
/ tscale
327 + temp_user
.QuadPart
/ tscale
;
330 DebPrint (("GetThreadTimes failed with error code %lu\n",
336 FILETIME current_ftime
;
339 GetSystemTimeAsFileTime (¤t_ftime
);
341 temp
.LowPart
= current_ftime
.dwLowDateTime
;
342 temp
.HighPart
= current_ftime
.dwHighDateTime
;
344 retval
= temp
.QuadPart
/ tscale
;
350 /* Thread function for a timer thread. */
352 timer_loop (LPVOID arg
)
354 struct itimer_data
*itimer
= (struct itimer_data
*)arg
;
355 int which
= itimer
->type
;
356 int sig
= (which
== ITIMER_REAL
) ? SIGALRM
: SIGPROF
;
357 CRITICAL_SECTION
*crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
358 const DWORD max_sleep
= MAX_SINGLE_SLEEP
* 1000 / TIMER_TICKS_PER_SEC
;
359 HANDLE hth
= (which
== ITIMER_REAL
) ? NULL
: itimer
->caller_thread
;
364 signal_handler handler
;
365 ULONGLONG now
, expire
, reload
;
367 /* Load new values if requested by setitimer. */
368 EnterCriticalSection (crit
);
369 expire
= itimer
->expire
;
370 reload
= itimer
->reload
;
371 LeaveCriticalSection (crit
);
372 if (itimer
->terminate
)
382 if (expire
> (now
= w32_get_timer_time (hth
)))
383 sleep_time
= expire
- now
;
386 /* Don't sleep too long at a time, to be able to see the
387 termination flag without too long a delay. */
388 while (sleep_time
> max_sleep
)
390 if (itimer
->terminate
)
393 EnterCriticalSection (crit
);
394 expire
= itimer
->expire
;
395 LeaveCriticalSection (crit
);
397 (expire
> (now
= w32_get_timer_time (hth
))) ? expire
- now
: 0;
399 if (itimer
->terminate
)
403 Sleep (sleep_time
* 1000 / TIMER_TICKS_PER_SEC
);
404 /* Always sleep past the expiration time, to make sure we
405 never call the handler _before_ the expiration time,
406 always slightly after it. Sleep(5) makes sure we don't
407 hog the CPU by calling 'w32_get_timer_time' with high
408 frequency, and also let other threads work. */
409 while (w32_get_timer_time (hth
) < expire
)
413 EnterCriticalSection (crit
);
414 expire
= itimer
->expire
;
415 LeaveCriticalSection (crit
);
420 handler
= sig_handlers
[sig
];
421 if (!(handler
== SIG_DFL
|| handler
== SIG_IGN
|| handler
== SIG_ERR
)
422 /* FIXME: Don't ignore masked signals. Instead, record that
423 they happened and reissue them when the signal is
425 && !sigismember (&sig_mask
, sig
)
426 /* Simulate masking of SIGALRM and SIGPROF when processing
428 && !fatal_error_in_progress
429 && itimer
->caller_thread
)
431 /* Simulate a signal delivered to the thread which installed
432 the timer, by suspending that thread while the handler
434 HANDLE th
= itimer
->caller_thread
;
435 DWORD result
= SuspendThread (th
);
437 if (result
== (DWORD
)-1)
444 /* Update expiration time and loop. */
445 EnterCriticalSection (crit
);
446 expire
= itimer
->expire
;
449 LeaveCriticalSection (crit
);
452 reload
= itimer
->reload
;
455 now
= w32_get_timer_time (hth
);
458 ULONGLONG lag
= now
- expire
;
460 /* If we missed some opportunities (presumably while
461 sleeping or while the signal handler ran), skip
464 expire
= now
- (lag
% reload
);
470 expire
= 0; /* become idle */
471 itimer
->expire
= expire
;
472 LeaveCriticalSection (crit
);
478 stop_timer_thread (int which
)
480 struct itimer_data
*itimer
=
481 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
483 DWORD err
, exit_code
= 255;
486 /* Signal the thread that it should terminate. */
487 itimer
->terminate
= 1;
489 if (itimer
->timer_thread
== NULL
)
492 /* Wait for the timer thread to terminate voluntarily, then kill it
493 if it doesn't. This loop waits twice more than the maximum
494 amount of time a timer thread sleeps, see above. */
495 for (i
= 0; i
< MAX_SINGLE_SLEEP
/ 5; i
++)
497 if (!((status
= GetExitCodeThread (itimer
->timer_thread
, &exit_code
))
498 && exit_code
== STILL_ACTIVE
))
502 if ((status
== FALSE
&& (err
= GetLastError ()) == ERROR_INVALID_HANDLE
)
503 || exit_code
== STILL_ACTIVE
)
505 if (!(status
== FALSE
&& err
== ERROR_INVALID_HANDLE
))
506 TerminateThread (itimer
->timer_thread
, 0);
510 CloseHandle (itimer
->timer_thread
);
511 itimer
->timer_thread
= NULL
;
512 if (itimer
->caller_thread
)
514 CloseHandle (itimer
->caller_thread
);
515 itimer
->caller_thread
= NULL
;
519 /* This is called at shutdown time from term_ntproc. */
523 if (real_itimer
.timer_thread
)
524 stop_timer_thread (ITIMER_REAL
);
525 if (prof_itimer
.timer_thread
)
526 stop_timer_thread (ITIMER_PROF
);
528 /* We are going to delete the critical sections, so timers cannot
532 DeleteCriticalSection (&crit_real
);
533 DeleteCriticalSection (&crit_prof
);
534 DeleteCriticalSection (&crit_sig
);
537 /* This is called at initialization time from init_ntproc. */
541 /* GetThreadTimes is not available on all versions of Windows, so
542 need to probe for its availability dynamically, and call it
543 through a pointer. */
544 s_pfn_Get_Thread_Times
= NULL
; /* in case dumped Emacs comes with a value */
545 if (os_subtype
!= OS_9X
)
546 s_pfn_Get_Thread_Times
=
547 (GetThreadTimes_Proc
)GetProcAddress (GetModuleHandle ("kernel32.dll"),
550 /* Make sure we start with zeroed out itimer structures, since
551 dumping may have left there traces of threads long dead. */
552 memset (&real_itimer
, 0, sizeof real_itimer
);
553 memset (&prof_itimer
, 0, sizeof prof_itimer
);
555 InitializeCriticalSection (&crit_real
);
556 InitializeCriticalSection (&crit_prof
);
557 InitializeCriticalSection (&crit_sig
);
563 start_timer_thread (int which
)
567 struct itimer_data
*itimer
=
568 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
570 if (itimer
->timer_thread
571 && GetExitCodeThread (itimer
->timer_thread
, &exit_code
)
572 && exit_code
== STILL_ACTIVE
)
575 /* Clean up after possibly exited thread. */
576 if (itimer
->timer_thread
)
578 CloseHandle (itimer
->timer_thread
);
579 itimer
->timer_thread
= NULL
;
581 if (itimer
->caller_thread
)
583 CloseHandle (itimer
->caller_thread
);
584 itimer
->caller_thread
= NULL
;
587 /* Start a new thread. */
588 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
589 GetCurrentProcess (), &th
, 0, FALSE
,
590 DUPLICATE_SAME_ACCESS
))
595 itimer
->terminate
= 0;
596 itimer
->type
= which
;
597 itimer
->caller_thread
= th
;
598 /* Request that no more than 64KB of stack be reserved for this
599 thread, to avoid reserving too much memory, which would get in
600 the way of threads we start to wait for subprocesses. See also
602 itimer
->timer_thread
= CreateThread (NULL
, 64 * 1024, timer_loop
,
603 (void *)itimer
, 0x00010000, NULL
);
605 if (!itimer
->timer_thread
)
607 CloseHandle (itimer
->caller_thread
);
608 itimer
->caller_thread
= NULL
;
613 /* This is needed to make sure that the timer thread running for
614 profiling gets CPU as soon as the Sleep call terminates. */
615 if (which
== ITIMER_PROF
)
616 SetThreadPriority (itimer
->timer_thread
, THREAD_PRIORITY_TIME_CRITICAL
);
621 /* Most of the code of getitimer and setitimer (but not of their
622 subroutines) was shamelessly stolen from itimer.c in the DJGPP
623 library, see www.delorie.com/djgpp. */
625 getitimer (int which
, struct itimerval
*value
)
627 volatile ULONGLONG
*t_expire
;
628 volatile ULONGLONG
*t_reload
;
629 ULONGLONG expire
, reload
;
631 CRITICAL_SECTION
*crit
;
632 struct itimer_data
*itimer
;
643 if (which
!= ITIMER_REAL
&& which
!= ITIMER_PROF
)
649 itimer
= (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
651 ticks_now
= w32_get_timer_time ((which
== ITIMER_REAL
)
653 : GetCurrentThread ());
655 t_expire
= &itimer
->expire
;
656 t_reload
= &itimer
->reload
;
657 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
659 EnterCriticalSection (crit
);
662 LeaveCriticalSection (crit
);
667 value
->it_value
.tv_sec
= expire
/ TIMER_TICKS_PER_SEC
;
669 (expire
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
670 value
->it_value
.tv_usec
= usecs
;
671 value
->it_interval
.tv_sec
= reload
/ TIMER_TICKS_PER_SEC
;
673 (reload
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
674 value
->it_interval
.tv_usec
= usecs
;
680 setitimer(int which
, struct itimerval
*value
, struct itimerval
*ovalue
)
682 volatile ULONGLONG
*t_expire
, *t_reload
;
683 ULONGLONG expire
, reload
, expire_old
, reload_old
;
685 CRITICAL_SECTION
*crit
;
686 struct itimerval tem
, *ptem
;
691 /* Posix systems expect timer values smaller than the resolution of
692 the system clock be rounded up to the clock resolution. First
693 time we are called, measure the clock tick resolution. */
698 for (t1
= w32_get_timer_time (NULL
);
699 (t2
= w32_get_timer_time (NULL
)) == t1
; )
701 clocks_min
= t2
- t1
;
709 if (getitimer (which
, ptem
)) /* also sets ticks_now */
710 return -1; /* errno already set */
713 (which
== ITIMER_REAL
) ? &real_itimer
.expire
: &prof_itimer
.expire
;
715 (which
== ITIMER_REAL
) ? &real_itimer
.reload
: &prof_itimer
.reload
;
717 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
720 || (value
->it_value
.tv_sec
== 0 && value
->it_value
.tv_usec
== 0))
722 EnterCriticalSection (crit
);
723 /* Disable the timer. */
726 LeaveCriticalSection (crit
);
730 reload
= value
->it_interval
.tv_sec
* TIMER_TICKS_PER_SEC
;
732 usecs
= value
->it_interval
.tv_usec
;
733 if (value
->it_interval
.tv_sec
== 0
734 && usecs
&& usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
738 usecs
*= TIMER_TICKS_PER_SEC
;
739 reload
+= usecs
/ 1000000;
742 expire
= value
->it_value
.tv_sec
* TIMER_TICKS_PER_SEC
;
743 usecs
= value
->it_value
.tv_usec
;
744 if (value
->it_value
.tv_sec
== 0
745 && usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
749 usecs
*= TIMER_TICKS_PER_SEC
;
750 expire
+= usecs
/ 1000000;
755 EnterCriticalSection (crit
);
756 expire_old
= *t_expire
;
757 reload_old
= *t_reload
;
758 if (!(expire
== expire_old
&& reload
== reload_old
))
763 LeaveCriticalSection (crit
);
765 return start_timer_thread (which
);
771 #ifdef HAVE_SETITIMER
772 struct itimerval new_values
, old_values
;
774 new_values
.it_value
.tv_sec
= seconds
;
775 new_values
.it_value
.tv_usec
= 0;
776 new_values
.it_interval
.tv_sec
= new_values
.it_interval
.tv_usec
= 0;
778 if (setitimer (ITIMER_REAL
, &new_values
, &old_values
) < 0)
780 return old_values
.it_value
.tv_sec
;
786 /* Defined in <process.h> which conflicts with the local copy */
789 /* Child process management list. */
790 int child_proc_count
= 0;
791 child_process child_procs
[ MAX_CHILDREN
];
793 static DWORD WINAPI
reader_thread (void *arg
);
795 /* Find an unused process slot. */
802 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
803 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
805 if (child_proc_count
== MAX_CHILDREN
)
807 cp
= &child_procs
[child_proc_count
++];
810 memset (cp
, 0, sizeof (*cp
));
813 cp
->procinfo
.hProcess
= NULL
;
814 cp
->status
= STATUS_READ_ERROR
;
815 cp
->input_file
= NULL
;
816 cp
->pending_deletion
= 0;
818 /* use manual reset event so that select() will function properly */
819 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
822 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
823 if (cp
->char_consumed
)
825 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
826 It means that the 64K stack we are requesting in the 2nd
827 argument is how much memory should be reserved for the
828 stack. If we don't use this flag, the memory requested
829 by the 2nd argument is the amount actually _committed_,
830 but Windows reserves 8MB of memory for each thread's
831 stack. (The 8MB figure comes from the -stack
832 command-line argument we pass to the linker when building
833 Emacs, but that's because we need a large stack for
834 Emacs's main thread.) Since we request 2GB of reserved
835 memory at startup (see w32heap.c), which is close to the
836 maximum memory available for a 32-bit process on Windows,
837 the 8MB reservation for each thread causes failures in
838 starting subprocesses, because we create a thread running
839 reader_thread for each subprocess. As 8MB of stack is
840 way too much for reader_thread, forcing Windows to
841 reserve less wins the day. */
842 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
853 delete_child (child_process
*cp
)
857 /* Should not be deleting a child that is still needed. */
858 for (i
= 0; i
< MAXDESC
; i
++)
859 if (fd_info
[i
].cp
== cp
)
862 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
865 /* Delete the child's temporary input file, if any, that is pending
869 if (cp
->pending_deletion
)
871 if (unlink (cp
->input_file
))
872 DebPrint (("delete_child.unlink (%s) failed, errno: %d\n",
873 cp
->input_file
, errno
));
874 cp
->pending_deletion
= 0;
876 xfree (cp
->input_file
);
877 cp
->input_file
= NULL
;
880 /* reap thread if necessary */
885 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
887 /* let the thread exit cleanly if possible */
888 cp
->status
= STATUS_READ_ERROR
;
889 SetEvent (cp
->char_consumed
);
891 /* We used to forcibly terminate the thread here, but it
892 is normally unnecessary, and in abnormal cases, the worst that
893 will happen is we have an extra idle thread hanging around
894 waiting for the zombie process. */
895 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
897 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
898 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
899 TerminateThread (cp
->thrd
, 0);
903 CloseHandle (cp
->thrd
);
908 CloseHandle (cp
->char_avail
);
909 cp
->char_avail
= NULL
;
911 if (cp
->char_consumed
)
913 CloseHandle (cp
->char_consumed
);
914 cp
->char_consumed
= NULL
;
917 /* update child_proc_count (highest numbered slot in use plus one) */
918 if (cp
== child_procs
+ child_proc_count
- 1)
920 for (i
= child_proc_count
-1; i
>= 0; i
--)
921 if (CHILD_ACTIVE (&child_procs
[i
])
922 || child_procs
[i
].procinfo
.hProcess
!= NULL
)
924 child_proc_count
= i
+ 1;
929 child_proc_count
= 0;
932 /* Find a child by pid. */
933 static child_process
*
934 find_child_pid (DWORD pid
)
938 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
939 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
!= NULL
)
946 /* Thread proc for child process and socket reader threads. Each thread
947 is normally blocked until woken by select() to check for input by
948 reading one char. When the read completes, char_avail is signaled
949 to wake up the select emulator and the thread blocks itself again. */
951 reader_thread (void *arg
)
956 cp
= (child_process
*)arg
;
958 /* We have to wait for the go-ahead before we can start */
960 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
968 if (fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
969 rc
= _sys_wait_accept (cp
->fd
);
971 rc
= _sys_read_ahead (cp
->fd
);
973 /* The name char_avail is a misnomer - it really just means the
974 read-ahead has completed, whether successfully or not. */
975 if (!SetEvent (cp
->char_avail
))
977 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
978 GetLastError (), cp
->fd
));
982 if (rc
== STATUS_READ_ERROR
)
985 /* If the read died, the child has died so let the thread die */
986 if (rc
== STATUS_READ_FAILED
)
989 /* Wait until our input is acknowledged before reading again */
990 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
992 DebPrint (("reader_thread.WaitForSingleObject failed with "
993 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
1000 /* To avoid Emacs changing directory, we just record here the directory
1001 the new process should start in. This is set just before calling
1002 sys_spawnve, and is not generally valid at any other time. */
1003 static char * process_dir
;
1006 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
1007 int * pPid
, child_process
*cp
)
1010 SECURITY_ATTRIBUTES sec_attrs
;
1012 SECURITY_DESCRIPTOR sec_desc
;
1015 char dir
[ MAXPATHLEN
];
1017 if (cp
== NULL
) emacs_abort ();
1019 memset (&start
, 0, sizeof (start
));
1020 start
.cb
= sizeof (start
);
1023 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1024 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1026 start
.dwFlags
= STARTF_USESTDHANDLES
;
1027 start
.wShowWindow
= SW_HIDE
;
1029 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1030 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1031 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1032 #endif /* HAVE_NTGUI */
1035 /* Explicitly specify no security */
1036 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1038 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1041 sec_attrs
.nLength
= sizeof (sec_attrs
);
1042 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1043 sec_attrs
.bInheritHandle
= FALSE
;
1045 strcpy (dir
, process_dir
);
1046 unixtodos_filename (dir
);
1048 flags
= (!NILP (Vw32_start_process_share_console
)
1049 ? CREATE_NEW_PROCESS_GROUP
1050 : CREATE_NEW_CONSOLE
);
1051 if (NILP (Vw32_start_process_inherit_error_mode
))
1052 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1053 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1054 flags
, env
, dir
, &start
, &cp
->procinfo
))
1057 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1059 /* Hack for Windows 95, which assigns large (ie negative) pids */
1068 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1072 /* create_child doesn't know what emacs' file handle will be for waiting
1073 on output from the child, so we need to make this additional call
1074 to register the handle with the process
1075 This way the select emulator knows how to match file handles with
1076 entries in child_procs. */
1078 register_child (pid_t pid
, int fd
)
1082 cp
= find_child_pid ((DWORD
)pid
);
1085 DebPrint (("register_child unable to find pid %lu\n", pid
));
1090 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1095 /* thread is initially blocked until select is called; set status so
1096 that select will release thread */
1097 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1099 /* attach child_process to fd_info */
1100 if (fd_info
[fd
].cp
!= NULL
)
1102 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1106 fd_info
[fd
].cp
= cp
;
1109 /* Record INFILE as an input file for process PID. */
1111 record_infile (pid_t pid
, char *infile
)
1115 /* INFILE should never be NULL, since xstrdup would have signaled
1116 memory full condition in that case, see callproc.c where this
1117 function is called. */
1120 cp
= find_child_pid ((DWORD
)pid
);
1123 DebPrint (("record_infile is unable to find pid %lu\n", pid
));
1127 cp
->input_file
= infile
;
1130 /* Mark the input file INFILE of the corresponding subprocess as
1131 temporary, to be deleted when the subprocess exits. */
1133 record_pending_deletion (char *infile
)
1139 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1140 if (CHILD_ACTIVE (cp
)
1141 && cp
->input_file
&& xstrcasecmp (cp
->input_file
, infile
) == 0)
1143 cp
->pending_deletion
= 1;
1148 /* Called from waitpid when a process exits. */
1150 reap_subprocess (child_process
*cp
)
1152 if (cp
->procinfo
.hProcess
)
1154 /* Reap the process */
1156 /* Process should have already died before we are called. */
1157 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1158 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp
->fd
));
1160 CloseHandle (cp
->procinfo
.hProcess
);
1161 cp
->procinfo
.hProcess
= NULL
;
1162 CloseHandle (cp
->procinfo
.hThread
);
1163 cp
->procinfo
.hThread
= NULL
;
1166 /* For asynchronous children, the child_proc resources will be freed
1167 when the last pipe read descriptor is closed; for synchronous
1168 children, we must explicitly free the resources now because
1169 register_child has not been called. */
1174 /* Wait for a child process specified by PID, or for any of our
1175 existing child processes (if PID is nonpositive) to die. When it
1176 does, close its handle. Return the pid of the process that died
1177 and fill in STATUS if non-NULL. */
1180 waitpid (pid_t pid
, int *status
, int options
)
1182 DWORD active
, retval
;
1184 child_process
*cp
, *cps
[MAX_CHILDREN
];
1185 HANDLE wait_hnd
[MAX_CHILDREN
];
1187 int dont_wait
= (options
& WNOHANG
) != 0;
1190 /* According to Posix:
1192 PID = -1 means status is requested for any child process.
1194 PID > 0 means status is requested for a single child process
1197 PID = 0 means status is requested for any child process whose
1198 process group ID is equal to that of the calling process. But
1199 since Windows has only a limited support for process groups (only
1200 for console processes and only for the purposes of passing
1201 Ctrl-BREAK signal to them), and since we have no documented way
1202 of determining whether a given process belongs to our group, we
1205 PID < -1 means status is requested for any child process whose
1206 process group ID is equal to the absolute value of PID. Again,
1207 since we don't support process groups, we treat that as -1. */
1212 /* We are requested to wait for a specific child. */
1213 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1215 /* Some child_procs might be sockets; ignore them. Also
1216 ignore subprocesses whose output is not yet completely
1218 if (CHILD_ACTIVE (cp
)
1219 && cp
->procinfo
.hProcess
1228 if (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1230 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1236 /* PID specifies our subprocess, but its status is not
1243 /* No such child process, or nothing to wait for, so fail. */
1250 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1252 if (CHILD_ACTIVE (cp
)
1253 && cp
->procinfo
.hProcess
1254 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1256 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1263 /* Nothing to wait on, so fail. */
1272 timeout_ms
= 1000; /* check for quit about once a second. */
1277 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, timeout_ms
);
1278 } while (active
== WAIT_TIMEOUT
&& !dont_wait
);
1280 if (active
== WAIT_FAILED
)
1285 else if (active
== WAIT_TIMEOUT
&& dont_wait
)
1287 /* PID specifies our subprocess, but it didn't exit yet, so its
1288 status is not yet available. */
1290 DebPrint (("Wait: PID %d not reap yet\n", cp
->pid
));
1294 else if (active
>= WAIT_OBJECT_0
1295 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1297 active
-= WAIT_OBJECT_0
;
1299 else if (active
>= WAIT_ABANDONED_0
1300 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1302 active
-= WAIT_ABANDONED_0
;
1307 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1309 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1313 if (retval
== STILL_ACTIVE
)
1315 /* Should never happen. */
1316 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1317 if (pid
> 0 && dont_wait
)
1323 /* Massage the exit code from the process to match the format expected
1324 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1325 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1327 if (retval
== STATUS_CONTROL_C_EXIT
)
1332 if (pid
> 0 && active
!= 0)
1337 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1342 reap_subprocess (cp
);
1347 /* Old versions of w32api headers don't have separate 32-bit and
1348 64-bit defines, but the one they have matches the 32-bit variety. */
1349 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1350 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1351 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1355 w32_executable_type (char * filename
,
1357 int * is_cygnus_app
,
1360 file_data executable
;
1363 /* Default values in case we can't tell for sure. */
1364 *is_dos_app
= FALSE
;
1365 *is_cygnus_app
= FALSE
;
1366 *is_gui_app
= FALSE
;
1368 if (!open_input_file (&executable
, filename
))
1371 p
= strrchr (filename
, '.');
1373 /* We can only identify DOS .com programs from the extension. */
1374 if (p
&& xstrcasecmp (p
, ".com") == 0)
1376 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1377 || xstrcasecmp (p
, ".cmd") == 0))
1379 /* A DOS shell script - it appears that CreateProcess is happy to
1380 accept this (somewhat surprisingly); presumably it looks at
1381 COMSPEC to determine what executable to actually invoke.
1382 Therefore, we have to do the same here as well. */
1383 /* Actually, I think it uses the program association for that
1384 extension, which is defined in the registry. */
1385 p
= egetenv ("COMSPEC");
1387 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
1391 /* Look for DOS .exe signature - if found, we must also check that
1392 it isn't really a 16- or 32-bit Windows exe, since both formats
1393 start with a DOS program stub. Note that 16-bit Windows
1394 executables use the OS/2 1.x format. */
1396 IMAGE_DOS_HEADER
* dos_header
;
1397 IMAGE_NT_HEADERS
* nt_header
;
1399 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1400 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1403 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1405 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1407 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1410 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1411 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1415 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1417 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1418 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1420 /* Ensure we are using the 32 bit structure. */
1421 IMAGE_OPTIONAL_HEADER32
*opt
1422 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1423 data_dir
= opt
->DataDirectory
;
1424 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1426 /* MingW 3.12 has the required 64 bit structs, but in case older
1427 versions don't, only check 64 bit exes if we know how. */
1428 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1429 else if (nt_header
->OptionalHeader
.Magic
1430 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1432 IMAGE_OPTIONAL_HEADER64
*opt
1433 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1434 data_dir
= opt
->DataDirectory
;
1435 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1440 /* Look for cygwin.dll in DLL import list. */
1441 IMAGE_DATA_DIRECTORY import_dir
=
1442 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1443 IMAGE_IMPORT_DESCRIPTOR
* imports
;
1444 IMAGE_SECTION_HEADER
* section
;
1446 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
1447 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
1450 for ( ; imports
->Name
; imports
++)
1452 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1455 /* The exact name of the cygwin dll has changed with
1456 various releases, but hopefully this will be reasonably
1458 if (strncmp (dllname
, "cygwin", 6) == 0)
1460 *is_cygnus_app
= TRUE
;
1469 close_file_data (&executable
);
1473 compare_env (const void *strp1
, const void *strp2
)
1475 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1477 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1479 /* Sort order in command.com/cmd.exe is based on uppercasing
1480 names, so do the same here. */
1481 if (toupper (*str1
) > toupper (*str2
))
1483 else if (toupper (*str1
) < toupper (*str2
))
1488 if (*str1
== '=' && *str2
== '=')
1490 else if (*str1
== '=')
1497 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1499 char **optr
, **nptr
;
1511 num
+= optr
- envp2
;
1513 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1518 /* When a new child process is created we need to register it in our list,
1519 so intercept spawn requests. */
1521 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1523 Lisp_Object program
, full
;
1524 char *cmdline
, *env
, *parg
, **targ
;
1528 int is_dos_app
, is_cygnus_app
, is_gui_app
;
1531 /* We pass our process ID to our children by setting up an environment
1532 variable in their environment. */
1533 char ppid_env_var_buffer
[64];
1534 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1535 /* These are the characters that cause an argument to need quoting.
1536 Arguments with whitespace characters need quoting to prevent the
1537 argument being split into two or more. Arguments with wildcards
1538 are also quoted, for consistency with posix platforms, where wildcards
1539 are not expanded if we run the program directly without a shell.
1540 Some extra whitespace characters need quoting in Cygwin programs,
1541 so this list is conditionally modified below. */
1542 char *sepchars
= " \t*?";
1544 /* We don't care about the other modes */
1545 if (mode
!= _P_NOWAIT
)
1551 /* Handle executable names without an executable suffix. */
1552 program
= build_string (cmdname
);
1553 if (NILP (Ffile_executable_p (program
)))
1555 struct gcpro gcpro1
;
1559 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
1569 /* make sure argv[0] and cmdname are both in DOS format */
1570 cmdname
= SDATA (program
);
1571 unixtodos_filename (cmdname
);
1574 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1575 executable that is implicitly linked to the Cygnus dll (implying it
1576 was compiled with the Cygnus GNU toolchain and hence relies on
1577 cygwin.dll to parse the command line - we use this to decide how to
1578 escape quote chars in command line args that must be quoted).
1580 Also determine whether it is a GUI app, so that we don't hide its
1581 initial window unless specifically requested. */
1582 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
1584 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1585 application to start it by specifying the helper app as cmdname,
1586 while leaving the real app name as argv[0]. */
1589 cmdname
= alloca (MAXPATHLEN
);
1590 if (egetenv ("CMDPROXY"))
1591 strcpy (cmdname
, egetenv ("CMDPROXY"));
1594 strcpy (cmdname
, SDATA (Vinvocation_directory
));
1595 strcat (cmdname
, "cmdproxy.exe");
1597 unixtodos_filename (cmdname
);
1600 /* we have to do some conjuring here to put argv and envp into the
1601 form CreateProcess wants... argv needs to be a space separated/null
1602 terminated list of parameters, and envp is a null
1603 separated/double-null terminated list of parameters.
1605 Additionally, zero-length args and args containing whitespace or
1606 quote chars need to be wrapped in double quotes - for this to work,
1607 embedded quotes need to be escaped as well. The aim is to ensure
1608 the child process reconstructs the argv array we start with
1609 exactly, so we treat quotes at the beginning and end of arguments
1612 The w32 GNU-based library from Cygnus doubles quotes to escape
1613 them, while MSVC uses backslash for escaping. (Actually the MSVC
1614 startup code does attempt to recognize doubled quotes and accept
1615 them, but gets it wrong and ends up requiring three quotes to get a
1616 single embedded quote!) So by default we decide whether to use
1617 quote or backslash as the escape character based on whether the
1618 binary is apparently a Cygnus compiled app.
1620 Note that using backslash to escape embedded quotes requires
1621 additional special handling if an embedded quote is already
1622 preceded by backslash, or if an arg requiring quoting ends with
1623 backslash. In such cases, the run of escape characters needs to be
1624 doubled. For consistency, we apply this special handling as long
1625 as the escape character is not quote.
1627 Since we have no idea how large argv and envp are likely to be we
1628 figure out list lengths on the fly and allocate them. */
1630 if (!NILP (Vw32_quote_process_args
))
1633 /* Override escape char by binding w32-quote-process-args to
1634 desired character, or use t for auto-selection. */
1635 if (INTEGERP (Vw32_quote_process_args
))
1636 escape_char
= XINT (Vw32_quote_process_args
);
1638 escape_char
= is_cygnus_app
? '"' : '\\';
1641 /* Cygwin apps needs quoting a bit more often. */
1642 if (escape_char
== '"')
1643 sepchars
= "\r\n\t\f '";
1651 int need_quotes
= 0;
1652 int escape_char_run
= 0;
1658 if (escape_char
== '"' && *p
== '\\')
1659 /* If it's a Cygwin app, \ needs to be escaped. */
1663 /* allow for embedded quotes to be escaped */
1666 /* handle the case where the embedded quote is already escaped */
1667 if (escape_char_run
> 0)
1669 /* To preserve the arg exactly, we need to double the
1670 preceding escape characters (plus adding one to
1671 escape the quote character itself). */
1672 arglen
+= escape_char_run
;
1675 else if (strchr (sepchars
, *p
) != NULL
)
1680 if (*p
== escape_char
&& escape_char
!= '"')
1683 escape_char_run
= 0;
1688 /* handle the case where the arg ends with an escape char - we
1689 must not let the enclosing quote be escaped. */
1690 if (escape_char_run
> 0)
1691 arglen
+= escape_char_run
;
1693 arglen
+= strlen (*targ
++) + 1;
1695 cmdline
= alloca (arglen
);
1701 int need_quotes
= 0;
1709 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1714 int escape_char_run
= 0;
1720 last
= p
+ strlen (p
) - 1;
1723 /* This version does not escape quotes if they occur at the
1724 beginning or end of the arg - this could lead to incorrect
1725 behavior when the arg itself represents a command line
1726 containing quoted args. I believe this was originally done
1727 as a hack to make some things work, before
1728 `w32-quote-process-args' was added. */
1731 if (*p
== '"' && p
> first
&& p
< last
)
1732 *parg
++ = escape_char
; /* escape embedded quotes */
1740 /* double preceding escape chars if any */
1741 while (escape_char_run
> 0)
1743 *parg
++ = escape_char
;
1746 /* escape all quote chars, even at beginning or end */
1747 *parg
++ = escape_char
;
1749 else if (escape_char
== '"' && *p
== '\\')
1753 if (*p
== escape_char
&& escape_char
!= '"')
1756 escape_char_run
= 0;
1758 /* double escape chars before enclosing quote */
1759 while (escape_char_run
> 0)
1761 *parg
++ = escape_char
;
1769 strcpy (parg
, *targ
);
1770 parg
+= strlen (*targ
);
1780 numenv
= 1; /* for end null */
1783 arglen
+= strlen (*targ
++) + 1;
1786 /* extra env vars... */
1787 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
1788 GetCurrentProcessId ());
1789 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1792 /* merge env passed in and extra env into one, and sort it. */
1793 targ
= (char **) alloca (numenv
* sizeof (char *));
1794 merge_and_sort_env (envp
, extra_env
, targ
);
1796 /* concatenate env entries. */
1797 env
= alloca (arglen
);
1801 strcpy (parg
, *targ
);
1802 parg
+= strlen (*targ
++);
1815 /* Now create the process. */
1816 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1826 /* Emulate the select call
1827 Wait for available input on any of the given rfds, or timeout if
1828 a timeout is given and no input is detected
1829 wfds and efds are not supported and must be NULL.
1831 For simplicity, we detect the death of child processes here and
1832 synchronously call the SIGCHLD handler. Since it is possible for
1833 children to be created without a corresponding pipe handle from which
1834 to read output, we wait separately on the process handles as well as
1835 the char_avail events for each process pipe. We only call
1836 wait/reap_process when the process actually terminates.
1838 To reduce the number of places in which Emacs can be hung such that
1839 C-g is not able to interrupt it, we always wait on interrupt_handle
1840 (which is signaled by the input thread when C-g is detected). If we
1841 detect that we were woken up by C-g, we return -1 with errno set to
1842 EINTR as on Unix. */
1844 /* From w32console.c */
1845 extern HANDLE keyboard_handle
;
1847 /* From w32xfns.c */
1848 extern HANDLE interrupt_handle
;
1850 /* From process.c */
1851 extern int proc_buffered_char
[];
1854 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1855 EMACS_TIME
*timeout
, void *ignored
)
1858 DWORD timeout_ms
, start_time
;
1861 child_process
*cp
, *cps
[MAX_CHILDREN
];
1862 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1863 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1866 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
1868 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1869 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1875 /* Otherwise, we only handle rfds, so fail otherwise. */
1876 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1886 /* Always wait on interrupt_handle, to detect C-g (quit). */
1887 wait_hnd
[0] = interrupt_handle
;
1890 /* Build a list of pipe handles to wait on. */
1892 for (i
= 0; i
< nfds
; i
++)
1893 if (FD_ISSET (i
, &orfds
))
1897 if (keyboard_handle
)
1899 /* Handle stdin specially */
1900 wait_hnd
[nh
] = keyboard_handle
;
1905 /* Check for any emacs-generated input in the queue since
1906 it won't be detected in the wait */
1907 if (detect_input_pending ())
1915 /* Child process and socket/comm port input. */
1919 int current_status
= cp
->status
;
1921 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1923 /* Tell reader thread which file handle to use. */
1925 /* Wake up the reader thread for this process */
1926 cp
->status
= STATUS_READ_READY
;
1927 if (!SetEvent (cp
->char_consumed
))
1928 DebPrint (("sys_select.SetEvent failed with "
1929 "%lu for fd %ld\n", GetLastError (), i
));
1932 #ifdef CHECK_INTERLOCK
1933 /* slightly crude cross-checking of interlock between threads */
1935 current_status
= cp
->status
;
1936 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1938 /* char_avail has been signaled, so status (which may
1939 have changed) should indicate read has completed
1940 but has not been acknowledged. */
1941 current_status
= cp
->status
;
1942 if (current_status
!= STATUS_READ_SUCCEEDED
1943 && current_status
!= STATUS_READ_FAILED
)
1944 DebPrint (("char_avail set, but read not completed: status %d\n",
1949 /* char_avail has not been signaled, so status should
1950 indicate that read is in progress; small possibility
1951 that read has completed but event wasn't yet signaled
1952 when we tested it (because a context switch occurred
1953 or if running on separate CPUs). */
1954 if (current_status
!= STATUS_READ_READY
1955 && current_status
!= STATUS_READ_IN_PROGRESS
1956 && current_status
!= STATUS_READ_SUCCEEDED
1957 && current_status
!= STATUS_READ_FAILED
)
1958 DebPrint (("char_avail reset, but read status is bad: %d\n",
1962 wait_hnd
[nh
] = cp
->char_avail
;
1964 if (!wait_hnd
[nh
]) emacs_abort ();
1967 DebPrint (("select waiting on child %d fd %d\n",
1968 cp
-child_procs
, i
));
1973 /* Unable to find something to wait on for this fd, skip */
1975 /* Note that this is not a fatal error, and can in fact
1976 happen in unusual circumstances. Specifically, if
1977 sys_spawnve fails, eg. because the program doesn't
1978 exist, and debug-on-error is t so Fsignal invokes a
1979 nested input loop, then the process output pipe is
1980 still included in input_wait_mask with no child_proc
1981 associated with it. (It is removed when the debugger
1982 exits the nested input loop and the error is thrown.) */
1984 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
1990 /* Add handles of child processes. */
1992 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1993 /* Some child_procs might be sockets; ignore them. Also some
1994 children may have died already, but we haven't finished reading
1995 the process output; ignore them too. */
1996 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
1998 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
1999 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
2002 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
2007 /* Nothing to look for, so we didn't find anything */
2015 start_time
= GetTickCount ();
2017 /* Wait for input or child death to be signaled. If user input is
2018 allowed, then also accept window messages. */
2019 if (FD_ISSET (0, &orfds
))
2020 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
2023 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
2025 if (active
== WAIT_FAILED
)
2027 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2028 nh
+ nc
, timeout_ms
, GetLastError ()));
2029 /* don't return EBADF - this causes wait_reading_process_output to
2030 abort; WAIT_FAILED is returned when single-stepping under
2031 Windows 95 after switching thread focus in debugger, and
2032 possibly at other times. */
2036 else if (active
== WAIT_TIMEOUT
)
2040 else if (active
>= WAIT_OBJECT_0
2041 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
2043 active
-= WAIT_OBJECT_0
;
2045 else if (active
>= WAIT_ABANDONED_0
2046 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
2048 active
-= WAIT_ABANDONED_0
;
2053 /* Loop over all handles after active (now officially documented as
2054 being the first signaled handle in the array). We do this to
2055 ensure fairness, so that all channels with data available will be
2056 processed - otherwise higher numbered channels could be starved. */
2059 if (active
== nh
+ nc
)
2061 /* There are messages in the lisp thread's queue; we must
2062 drain the queue now to ensure they are processed promptly,
2063 because if we don't do so, we will not be woken again until
2064 further messages arrive.
2066 NB. If ever we allow window message procedures to callback
2067 into lisp, we will need to ensure messages are dispatched
2068 at a safe time for lisp code to be run (*), and we may also
2069 want to provide some hooks in the dispatch loop to cater
2070 for modeless dialogs created by lisp (ie. to register
2071 window handles to pass to IsDialogMessage).
2073 (*) Note that MsgWaitForMultipleObjects above is an
2074 internal dispatch point for messages that are sent to
2075 windows created by this thread. */
2076 if (drain_message_queue ()
2077 /* If drain_message_queue returns non-zero, that means
2078 we received a WM_EMACS_FILENOTIFY message. If this
2079 is a TTY frame, we must signal the caller that keyboard
2080 input is available, so that w32_console_read_socket
2081 will be called to pick up the notifications. If we
2082 don't do that, file notifications will only work when
2083 the Emacs TTY frame has focus. */
2084 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2085 /* they asked for stdin reads */
2086 && FD_ISSET (0, &orfds
)
2087 /* the stdin handle is valid */
2095 else if (active
>= nh
)
2097 cp
= cps
[active
- nh
];
2099 /* We cannot always signal SIGCHLD immediately; if we have not
2100 finished reading the process output, we must delay sending
2101 SIGCHLD until we do. */
2103 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
2104 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
2105 /* SIG_DFL for SIGCHLD is ignore */
2106 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2107 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2110 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2113 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2116 else if (fdindex
[active
] == -1)
2118 /* Quit (C-g) was detected. */
2122 else if (fdindex
[active
] == 0)
2124 /* Keyboard input available */
2130 /* must be a socket or pipe - read ahead should have
2131 completed, either succeeding or failing. */
2132 FD_SET (fdindex
[active
], rfds
);
2136 /* Even though wait_reading_process_output only reads from at most
2137 one channel, we must process all channels here so that we reap
2138 all children that have died. */
2139 while (++active
< nh
+ nc
)
2140 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2142 } while (active
< nh
+ nc
);
2144 /* If no input has arrived and timeout hasn't expired, wait again. */
2147 DWORD elapsed
= GetTickCount () - start_time
;
2149 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2151 if (timeout_ms
!= INFINITE
)
2152 timeout_ms
-= elapsed
;
2153 goto count_children
;
2160 /* Substitute for certain kill () operations */
2162 static BOOL CALLBACK
2163 find_child_console (HWND hwnd
, LPARAM arg
)
2165 child_process
* cp
= (child_process
*) arg
;
2169 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
2170 if (process_id
== cp
->procinfo
.dwProcessId
)
2172 char window_class
[32];
2174 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2175 if (strcmp (window_class
,
2176 (os_subtype
== OS_9X
)
2178 : "ConsoleWindowClass") == 0)
2188 /* Emulate 'kill', but only for other processes. */
2190 sys_kill (pid_t pid
, int sig
)
2194 int need_to_free
= 0;
2197 /* Each process is in its own process group. */
2201 /* Only handle signals that will result in the process dying */
2202 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
2208 cp
= find_child_pid (pid
);
2211 /* We were passed a PID of something other than our subprocess.
2212 If that is our own PID, we will send to ourself a message to
2213 close the selected frame, which does not necessarily
2214 terminates Emacs. But then we are not supposed to call
2215 sys_kill with our own PID. */
2216 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
2217 if (proc_hand
== NULL
)
2226 proc_hand
= cp
->procinfo
.hProcess
;
2227 pid
= cp
->procinfo
.dwProcessId
;
2229 /* Try to locate console window for process. */
2230 EnumWindows (find_child_console
, (LPARAM
) cp
);
2233 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2235 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2237 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2238 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2239 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2240 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2241 HWND foreground_window
;
2243 if (break_scan_code
== 0)
2245 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2246 vk_break_code
= 'C';
2247 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2250 foreground_window
= GetForegroundWindow ();
2251 if (foreground_window
)
2253 /* NT 5.0, and apparently also Windows 98, will not allow
2254 a Window to be set to foreground directly without the
2255 user's involvement. The workaround is to attach
2256 ourselves to the thread that owns the foreground
2257 window, since that is the only thread that can set the
2258 foreground window. */
2259 DWORD foreground_thread
, child_thread
;
2261 GetWindowThreadProcessId (foreground_window
, NULL
);
2262 if (foreground_thread
== GetCurrentThreadId ()
2263 || !AttachThreadInput (GetCurrentThreadId (),
2264 foreground_thread
, TRUE
))
2265 foreground_thread
= 0;
2267 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2268 if (child_thread
== GetCurrentThreadId ()
2269 || !AttachThreadInput (GetCurrentThreadId (),
2270 child_thread
, TRUE
))
2273 /* Set the foreground window to the child. */
2274 if (SetForegroundWindow (cp
->hwnd
))
2276 /* Generate keystrokes as if user had typed Ctrl-Break or
2278 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2279 keybd_event (vk_break_code
, break_scan_code
,
2280 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2281 keybd_event (vk_break_code
, break_scan_code
,
2282 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2283 | KEYEVENTF_KEYUP
, 0);
2284 keybd_event (VK_CONTROL
, control_scan_code
,
2285 KEYEVENTF_KEYUP
, 0);
2287 /* Sleep for a bit to give time for Emacs frame to respond
2288 to focus change events (if Emacs was active app). */
2291 SetForegroundWindow (foreground_window
);
2293 /* Detach from the foreground and child threads now that
2294 the foreground switching is over. */
2295 if (foreground_thread
)
2296 AttachThreadInput (GetCurrentThreadId (),
2297 foreground_thread
, FALSE
);
2299 AttachThreadInput (GetCurrentThreadId (),
2300 child_thread
, FALSE
);
2303 /* Ctrl-Break is NT equivalent of SIGINT. */
2304 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2306 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2307 "for pid %lu\n", GetLastError (), pid
));
2314 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2317 if (os_subtype
== OS_9X
)
2320 Another possibility is to try terminating the VDM out-right by
2321 calling the Shell VxD (id 0x17) V86 interface, function #4
2322 "SHELL_Destroy_VM", ie.
2328 First need to determine the current VM handle, and then arrange for
2329 the shellapi call to be made from the system vm (by using
2330 Switch_VM_and_callback).
2332 Could try to invoke DestroyVM through CallVxD.
2336 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2337 to hang when cmdproxy is used in conjunction with
2338 command.com for an interactive shell. Posting
2339 WM_CLOSE pops up a dialog that, when Yes is selected,
2340 does the same thing. TerminateProcess is also less
2341 than ideal in that subprocesses tend to stick around
2342 until the machine is shutdown, but at least it
2343 doesn't freeze the 16-bit subsystem. */
2344 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2346 if (!TerminateProcess (proc_hand
, 0xff))
2348 DebPrint (("sys_kill.TerminateProcess returned %d "
2349 "for pid %lu\n", GetLastError (), pid
));
2356 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2358 /* Kill the process. On W32 this doesn't kill child processes
2359 so it doesn't work very well for shells which is why it's not
2360 used in every case. */
2361 else if (!TerminateProcess (proc_hand
, 0xff))
2363 DebPrint (("sys_kill.TerminateProcess returned %d "
2364 "for pid %lu\n", GetLastError (), pid
));
2371 CloseHandle (proc_hand
);
2376 /* The following two routines are used to manipulate stdin, stdout, and
2377 stderr of our child processes.
2379 Assuming that in, out, and err are *not* inheritable, we make them
2380 stdin, stdout, and stderr of the child as follows:
2382 - Save the parent's current standard handles.
2383 - Set the std handles to inheritable duplicates of the ones being passed in.
2384 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2385 NT file handle for a crt file descriptor.)
2386 - Spawn the child, which inherits in, out, and err as stdin,
2387 stdout, and stderr. (see Spawnve)
2388 - Close the std handles passed to the child.
2389 - Reset the parent's standard handles to the saved handles.
2390 (see reset_standard_handles)
2391 We assume that the caller closes in, out, and err after calling us. */
2394 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2397 HANDLE newstdin
, newstdout
, newstderr
;
2399 parent
= GetCurrentProcess ();
2401 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2402 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2403 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2405 /* make inheritable copies of the new handles */
2406 if (!DuplicateHandle (parent
,
2407 (HANDLE
) _get_osfhandle (in
),
2412 DUPLICATE_SAME_ACCESS
))
2413 report_file_error ("Duplicating input handle for child", Qnil
);
2415 if (!DuplicateHandle (parent
,
2416 (HANDLE
) _get_osfhandle (out
),
2421 DUPLICATE_SAME_ACCESS
))
2422 report_file_error ("Duplicating output handle for child", Qnil
);
2424 if (!DuplicateHandle (parent
,
2425 (HANDLE
) _get_osfhandle (err
),
2430 DUPLICATE_SAME_ACCESS
))
2431 report_file_error ("Duplicating error handle for child", Qnil
);
2433 /* and store them as our std handles */
2434 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2435 report_file_error ("Changing stdin handle", Qnil
);
2437 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2438 report_file_error ("Changing stdout handle", Qnil
);
2440 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2441 report_file_error ("Changing stderr handle", Qnil
);
2445 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2447 /* close the duplicated handles passed to the child */
2448 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2449 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2450 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2452 /* now restore parent's saved std handles */
2453 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2454 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2455 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2459 set_process_dir (char * dir
)
2464 /* To avoid problems with winsock implementations that work over dial-up
2465 connections causing or requiring a connection to exist while Emacs is
2466 running, Emacs no longer automatically loads winsock on startup if it
2467 is present. Instead, it will be loaded when open-network-stream is
2470 To allow full control over when winsock is loaded, we provide these
2471 two functions to dynamically load and unload winsock. This allows
2472 dial-up users to only be connected when they actually need to use
2476 extern HANDLE winsock_lib
;
2477 extern BOOL
term_winsock (void);
2478 extern BOOL
init_winsock (int load_now
);
2480 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2481 doc
: /* Test for presence of the Windows socket library `winsock'.
2482 Returns non-nil if winsock support is present, nil otherwise.
2484 If the optional argument LOAD-NOW is non-nil, the winsock library is
2485 also loaded immediately if not already loaded. If winsock is loaded,
2486 the winsock local hostname is returned (since this may be different from
2487 the value of `system-name' and should supplant it), otherwise t is
2488 returned to indicate winsock support is present. */)
2489 (Lisp_Object load_now
)
2493 have_winsock
= init_winsock (!NILP (load_now
));
2496 if (winsock_lib
!= NULL
)
2498 /* Return new value for system-name. The best way to do this
2499 is to call init_system_name, saving and restoring the
2500 original value to avoid side-effects. */
2501 Lisp_Object orig_hostname
= Vsystem_name
;
2502 Lisp_Object hostname
;
2504 init_system_name ();
2505 hostname
= Vsystem_name
;
2506 Vsystem_name
= orig_hostname
;
2514 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2516 doc
: /* Unload the Windows socket library `winsock' if loaded.
2517 This is provided to allow dial-up socket connections to be disconnected
2518 when no longer needed. Returns nil without unloading winsock if any
2519 socket connections still exist. */)
2522 return term_winsock () ? Qt
: Qnil
;
2526 /* Some miscellaneous functions that are Windows specific, but not GUI
2527 specific (ie. are applicable in terminal or batch mode as well). */
2529 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2530 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2531 If FILENAME does not exist, return nil.
2532 All path elements in FILENAME are converted to their short names. */)
2533 (Lisp_Object filename
)
2535 char shortname
[MAX_PATH
];
2537 CHECK_STRING (filename
);
2539 /* first expand it. */
2540 filename
= Fexpand_file_name (filename
, Qnil
);
2542 /* luckily, this returns the short version of each element in the path. */
2543 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
2546 dostounix_filename (shortname
);
2548 return build_string (shortname
);
2552 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2554 doc
: /* Return the long file name version of the full path of FILENAME.
2555 If FILENAME does not exist, return nil.
2556 All path elements in FILENAME are converted to their long names. */)
2557 (Lisp_Object filename
)
2559 char longname
[ MAX_PATH
];
2562 CHECK_STRING (filename
);
2564 if (SBYTES (filename
) == 2
2565 && *(SDATA (filename
) + 1) == ':')
2568 /* first expand it. */
2569 filename
= Fexpand_file_name (filename
, Qnil
);
2571 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
2574 dostounix_filename (longname
);
2576 /* If we were passed only a drive, make sure that a slash is not appended
2577 for consistency with directories. Allow for drive mapping via SUBST
2578 in case expand-file-name is ever changed to expand those. */
2579 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2582 return DECODE_FILE (build_string (longname
));
2585 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2586 Sw32_set_process_priority
, 2, 2, 0,
2587 doc
: /* Set the priority of PROCESS to PRIORITY.
2588 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2589 priority of the process whose pid is PROCESS is changed.
2590 PRIORITY should be one of the symbols high, normal, or low;
2591 any other symbol will be interpreted as normal.
2593 If successful, the return value is t, otherwise nil. */)
2594 (Lisp_Object process
, Lisp_Object priority
)
2596 HANDLE proc_handle
= GetCurrentProcess ();
2597 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2598 Lisp_Object result
= Qnil
;
2600 CHECK_SYMBOL (priority
);
2602 if (!NILP (process
))
2607 CHECK_NUMBER (process
);
2609 /* Allow pid to be an internally generated one, or one obtained
2610 externally. This is necessary because real pids on Windows 95 are
2613 pid
= XINT (process
);
2614 cp
= find_child_pid (pid
);
2616 pid
= cp
->procinfo
.dwProcessId
;
2618 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
2621 if (EQ (priority
, Qhigh
))
2622 priority_class
= HIGH_PRIORITY_CLASS
;
2623 else if (EQ (priority
, Qlow
))
2624 priority_class
= IDLE_PRIORITY_CLASS
;
2626 if (proc_handle
!= NULL
)
2628 if (SetPriorityClass (proc_handle
, priority_class
))
2630 if (!NILP (process
))
2631 CloseHandle (proc_handle
);
2637 #ifdef HAVE_LANGINFO_CODESET
2638 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2640 nl_langinfo (nl_item item
)
2642 /* Conversion of Posix item numbers to their Windows equivalents. */
2643 static const LCTYPE w32item
[] = {
2644 LOCALE_IDEFAULTANSICODEPAGE
,
2645 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
2646 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
2647 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
2648 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
2649 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
2650 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
2653 static char *nl_langinfo_buf
= NULL
;
2654 static int nl_langinfo_len
= 0;
2656 if (nl_langinfo_len
<= 0)
2657 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
2659 if (item
< 0 || item
>= _NL_NUM
)
2660 nl_langinfo_buf
[0] = 0;
2663 LCID cloc
= GetThreadLocale ();
2664 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2668 nl_langinfo_buf
[0] = 0;
2671 if (item
== CODESET
)
2673 need_len
+= 2; /* for the "cp" prefix */
2674 if (need_len
< 8) /* for the case we call GetACP */
2677 if (nl_langinfo_len
<= need_len
)
2678 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
2679 nl_langinfo_len
= need_len
);
2680 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2681 nl_langinfo_buf
, nl_langinfo_len
))
2682 nl_langinfo_buf
[0] = 0;
2683 else if (item
== CODESET
)
2685 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
2686 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
2687 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
2690 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
2691 strlen (nl_langinfo_buf
) + 1);
2692 nl_langinfo_buf
[0] = 'c';
2693 nl_langinfo_buf
[1] = 'p';
2698 return nl_langinfo_buf
;
2700 #endif /* HAVE_LANGINFO_CODESET */
2702 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
2703 Sw32_get_locale_info
, 1, 2, 0,
2704 doc
: /* Return information about the Windows locale LCID.
2705 By default, return a three letter locale code which encodes the default
2706 language as the first two characters, and the country or regional variant
2707 as the third letter. For example, ENU refers to `English (United States)',
2708 while ENC means `English (Canadian)'.
2710 If the optional argument LONGFORM is t, the long form of the locale
2711 name is returned, e.g. `English (United States)' instead; if LONGFORM
2712 is a number, it is interpreted as an LCTYPE constant and the corresponding
2713 locale information is returned.
2715 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2716 (Lisp_Object lcid
, Lisp_Object longform
)
2720 char abbrev_name
[32] = { 0 };
2721 char full_name
[256] = { 0 };
2723 CHECK_NUMBER (lcid
);
2725 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2728 if (NILP (longform
))
2730 got_abbrev
= GetLocaleInfo (XINT (lcid
),
2731 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
2732 abbrev_name
, sizeof (abbrev_name
));
2734 return build_string (abbrev_name
);
2736 else if (EQ (longform
, Qt
))
2738 got_full
= GetLocaleInfo (XINT (lcid
),
2739 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
2740 full_name
, sizeof (full_name
));
2742 return DECODE_SYSTEM (build_string (full_name
));
2744 else if (NUMBERP (longform
))
2746 got_full
= GetLocaleInfo (XINT (lcid
),
2748 full_name
, sizeof (full_name
));
2749 /* GetLocaleInfo's return value includes the terminating null
2750 character, when the returned information is a string, whereas
2751 make_unibyte_string needs the string length without the
2752 terminating null. */
2754 return make_unibyte_string (full_name
, got_full
- 1);
2761 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
2762 Sw32_get_current_locale_id
, 0, 0, 0,
2763 doc
: /* Return Windows locale id for current locale setting.
2764 This is a numerical value; use `w32-get-locale-info' to convert to a
2765 human-readable form. */)
2768 return make_number (GetThreadLocale ());
2772 int_from_hex (char * s
)
2775 static char hex
[] = "0123456789abcdefABCDEF";
2778 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
2780 unsigned digit
= p
- hex
;
2783 val
= val
* 16 + digit
;
2789 /* We need to build a global list, since the EnumSystemLocale callback
2790 function isn't given a context pointer. */
2791 Lisp_Object Vw32_valid_locale_ids
;
2793 static BOOL CALLBACK
2794 enum_locale_fn (LPTSTR localeNum
)
2796 DWORD id
= int_from_hex (localeNum
);
2797 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2801 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2802 Sw32_get_valid_locale_ids
, 0, 0, 0,
2803 doc
: /* Return list of all valid Windows locale ids.
2804 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2805 human-readable form. */)
2808 Vw32_valid_locale_ids
= Qnil
;
2810 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2812 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2813 return Vw32_valid_locale_ids
;
2817 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2818 doc
: /* Return Windows locale id for default locale setting.
2819 By default, the system default locale setting is returned; if the optional
2820 parameter USERP is non-nil, the user default locale setting is returned.
2821 This is a numerical value; use `w32-get-locale-info' to convert to a
2822 human-readable form. */)
2826 return make_number (GetSystemDefaultLCID ());
2827 return make_number (GetUserDefaultLCID ());
2831 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2832 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2833 If successful, the new locale id is returned, otherwise nil. */)
2836 CHECK_NUMBER (lcid
);
2838 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2841 if (!SetThreadLocale (XINT (lcid
)))
2844 /* Need to set input thread locale if present. */
2845 if (dwWindowsThreadId
)
2846 /* Reply is not needed. */
2847 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2849 return make_number (GetThreadLocale ());
2853 /* We need to build a global list, since the EnumCodePages callback
2854 function isn't given a context pointer. */
2855 Lisp_Object Vw32_valid_codepages
;
2857 static BOOL CALLBACK
2858 enum_codepage_fn (LPTSTR codepageNum
)
2860 DWORD id
= atoi (codepageNum
);
2861 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2865 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2866 Sw32_get_valid_codepages
, 0, 0, 0,
2867 doc
: /* Return list of all valid Windows codepages. */)
2870 Vw32_valid_codepages
= Qnil
;
2872 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2874 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2875 return Vw32_valid_codepages
;
2879 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2880 Sw32_get_console_codepage
, 0, 0, 0,
2881 doc
: /* Return current Windows codepage for console input. */)
2884 return make_number (GetConsoleCP ());
2888 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2889 Sw32_set_console_codepage
, 1, 1, 0,
2890 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2891 This codepage setting affects keyboard input in tty mode.
2892 If successful, the new CP is returned, otherwise nil. */)
2897 if (!IsValidCodePage (XINT (cp
)))
2900 if (!SetConsoleCP (XINT (cp
)))
2903 return make_number (GetConsoleCP ());
2907 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2908 Sw32_get_console_output_codepage
, 0, 0, 0,
2909 doc
: /* Return current Windows codepage for console output. */)
2912 return make_number (GetConsoleOutputCP ());
2916 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2917 Sw32_set_console_output_codepage
, 1, 1, 0,
2918 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
2919 This codepage setting affects display in tty mode.
2920 If successful, the new CP is returned, otherwise nil. */)
2925 if (!IsValidCodePage (XINT (cp
)))
2928 if (!SetConsoleOutputCP (XINT (cp
)))
2931 return make_number (GetConsoleOutputCP ());
2935 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2936 Sw32_get_codepage_charset
, 1, 1, 0,
2937 doc
: /* Return charset ID corresponding to codepage CP.
2938 Returns nil if the codepage is not valid. */)
2945 if (!IsValidCodePage (XINT (cp
)))
2948 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2949 return make_number (info
.ciCharset
);
2955 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2956 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2957 doc
: /* Return list of Windows keyboard languages and layouts.
2958 The return value is a list of pairs of language id and layout id. */)
2961 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2962 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2963 Lisp_Object obj
= Qnil
;
2965 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2967 while (--num_layouts
>= 0)
2969 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2971 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2972 make_number ((kl
>> 16) & 0xffff)),
2981 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2982 Sw32_get_keyboard_layout
, 0, 0, 0,
2983 doc
: /* Return current Windows keyboard language and layout.
2984 The return value is the cons of the language id and the layout id. */)
2987 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
2989 return Fcons (make_number (kl
& 0xffff),
2990 make_number ((kl
>> 16) & 0xffff));
2994 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
2995 Sw32_set_keyboard_layout
, 1, 1, 0,
2996 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
2997 The keyboard layout setting affects interpretation of keyboard input.
2998 If successful, the new layout id is returned, otherwise nil. */)
2999 (Lisp_Object layout
)
3003 CHECK_CONS (layout
);
3004 CHECK_NUMBER_CAR (layout
);
3005 CHECK_NUMBER_CDR (layout
);
3007 kl
= (XINT (XCAR (layout
)) & 0xffff)
3008 | (XINT (XCDR (layout
)) << 16);
3010 /* Synchronize layout with input thread. */
3011 if (dwWindowsThreadId
)
3013 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
3017 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
3019 if (msg
.wParam
== 0)
3023 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
3026 return Fw32_get_keyboard_layout ();
3031 syms_of_ntproc (void)
3033 DEFSYM (Qhigh
, "high");
3034 DEFSYM (Qlow
, "low");
3036 defsubr (&Sw32_has_winsock
);
3037 defsubr (&Sw32_unload_winsock
);
3039 defsubr (&Sw32_short_file_name
);
3040 defsubr (&Sw32_long_file_name
);
3041 defsubr (&Sw32_set_process_priority
);
3042 defsubr (&Sw32_get_locale_info
);
3043 defsubr (&Sw32_get_current_locale_id
);
3044 defsubr (&Sw32_get_default_locale_id
);
3045 defsubr (&Sw32_get_valid_locale_ids
);
3046 defsubr (&Sw32_set_current_locale
);
3048 defsubr (&Sw32_get_console_codepage
);
3049 defsubr (&Sw32_set_console_codepage
);
3050 defsubr (&Sw32_get_console_output_codepage
);
3051 defsubr (&Sw32_set_console_output_codepage
);
3052 defsubr (&Sw32_get_valid_codepages
);
3053 defsubr (&Sw32_get_codepage_charset
);
3055 defsubr (&Sw32_get_valid_keyboard_layouts
);
3056 defsubr (&Sw32_get_keyboard_layout
);
3057 defsubr (&Sw32_set_keyboard_layout
);
3059 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
3060 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3061 Because Windows does not directly pass argv arrays to child processes,
3062 programs have to reconstruct the argv array by parsing the command
3063 line string. For an argument to contain a space, it must be enclosed
3064 in double quotes or it will be parsed as multiple arguments.
3066 If the value is a character, that character will be used to escape any
3067 quote characters that appear, otherwise a suitable escape character
3068 will be chosen based on the type of the program. */);
3069 Vw32_quote_process_args
= Qt
;
3071 DEFVAR_LISP ("w32-start-process-show-window",
3072 Vw32_start_process_show_window
,
3073 doc
: /* When nil, new child processes hide their windows.
3074 When non-nil, they show their window in the method of their choice.
3075 This variable doesn't affect GUI applications, which will never be hidden. */);
3076 Vw32_start_process_show_window
= Qnil
;
3078 DEFVAR_LISP ("w32-start-process-share-console",
3079 Vw32_start_process_share_console
,
3080 doc
: /* When nil, new child processes are given a new console.
3081 When non-nil, they share the Emacs console; this has the limitation of
3082 allowing only one DOS subprocess to run at a time (whether started directly
3083 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3084 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3085 otherwise respond to interrupts from Emacs. */);
3086 Vw32_start_process_share_console
= Qnil
;
3088 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3089 Vw32_start_process_inherit_error_mode
,
3090 doc
: /* When nil, new child processes revert to the default error mode.
3091 When non-nil, they inherit their error mode setting from Emacs, which stops
3092 them blocking when trying to access unmounted drives etc. */);
3093 Vw32_start_process_inherit_error_mode
= Qt
;
3095 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
3096 doc
: /* Forced delay before reading subprocess output.
3097 This is done to improve the buffering of subprocess output, by
3098 avoiding the inefficiency of frequently reading small amounts of data.
3100 If positive, the value is the number of milliseconds to sleep before
3101 reading the subprocess output. If negative, the magnitude is the number
3102 of time slices to wait (effectively boosting the priority of the child
3103 process temporarily). A value of zero disables waiting entirely. */);
3104 w32_pipe_read_delay
= 50;
3106 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
3107 doc
: /* Non-nil means convert all-upper case file names to lower case.
3108 This applies when performing completions and file name expansion.
3109 Note that the value of this setting also affects remote file names,
3110 so you probably don't want to set to non-nil if you use case-sensitive
3111 filesystems via ange-ftp. */);
3112 Vw32_downcase_file_names
= Qnil
;
3115 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3116 doc
: /* Non-nil means attempt to fake realistic inode values.
3117 This works by hashing the truename of files, and should detect
3118 aliasing between long and short (8.3 DOS) names, but can have
3119 false positives because of hash collisions. Note that determining
3120 the truename of a file can be slow. */);
3121 Vw32_generate_fake_inodes
= Qnil
;
3124 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3125 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3126 This option controls whether to issue additional system calls to determine
3127 accurate link counts, file type, and ownership information. It is more
3128 useful for files on NTFS volumes, where hard links and file security are
3129 supported, than on volumes of the FAT family.
3131 Without these system calls, link count will always be reported as 1 and file
3132 ownership will be attributed to the current user.
3133 The default value `local' means only issue these system calls for files
3134 on local fixed drives. A value of nil means never issue them.
3135 Any other non-nil value means do this even on remote and removable drives
3136 where the performance impact may be noticeable even on modern hardware. */);
3137 Vw32_get_true_file_attributes
= Qlocal
;
3139 staticpro (&Vw32_valid_locale_ids
);
3140 staticpro (&Vw32_valid_codepages
);
3142 /* end of w32proc.c */