Grammer fix
[emacs.git] / src / w32proc.c
blob2b583efba5612a92c357190011b6ac4b2bcfa074
1 /* Process support for GNU Emacs on the Microsoft Windows API.
3 Copyright (C) 1992, 1995, 1999-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 Drew Bliss Oct 14, 1993
22 Adapted from alarm.c by Tim Fleehart
25 #include <mingw_time.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <errno.h>
29 #include <ctype.h>
30 #include <io.h>
31 #include <fcntl.h>
32 #include <signal.h>
33 #include <sys/file.h>
34 #include <mbstring.h>
36 /* must include CRT headers *before* config.h */
37 #include <config.h>
39 #undef signal
40 #undef wait
41 #undef spawnve
42 #undef select
43 #undef kill
45 #include <windows.h>
46 #ifdef __GNUC__
47 /* This definition is missing from mingw32 headers. */
48 extern BOOL WINAPI IsValidLocale (LCID, DWORD);
49 #endif
51 #ifdef HAVE_LANGINFO_CODESET
52 #include <nl_types.h>
53 #include <langinfo.h>
54 #endif
56 #include "lisp.h"
57 #include "w32.h"
58 #include "w32common.h"
59 #include "w32heap.h"
60 #include "systime.h"
61 #include "syswait.h"
62 #include "process.h"
63 #include "syssignal.h"
64 #include "w32term.h"
65 #include "dispextern.h" /* for xstrcasecmp */
66 #include "coding.h"
68 #define RVA_TO_PTR(var,section,filedata) \
69 ((void *)((section)->PointerToRawData \
70 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
71 + (filedata).file_base))
73 Lisp_Object Qhigh, Qlow;
75 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
76 static signal_handler sig_handlers[NSIG];
78 static sigset_t sig_mask;
80 static CRITICAL_SECTION crit_sig;
82 /* Improve on the CRT 'signal' implementation so that we could record
83 the SIGCHLD handler and fake interval timers. */
84 signal_handler
85 sys_signal (int sig, signal_handler handler)
87 signal_handler old;
89 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
90 below. SIGALRM and SIGPROF are used by setitimer. All the
91 others are the only ones supported by the MS runtime. */
92 if (!(sig == SIGCHLD || sig == SIGSEGV || sig == SIGILL
93 || sig == SIGFPE || sig == SIGABRT || sig == SIGTERM
94 || sig == SIGALRM || sig == SIGPROF))
96 errno = EINVAL;
97 return SIG_ERR;
99 old = sig_handlers[sig];
100 /* SIGABRT is treated specially because w32.c installs term_ntproc
101 as its handler, so we don't want to override that afterwards.
102 Aborting Emacs works specially anyway: either by calling
103 emacs_abort directly or through terminate_due_to_signal, which
104 calls emacs_abort through emacs_raise. */
105 if (!(sig == SIGABRT && old == term_ntproc))
107 sig_handlers[sig] = handler;
108 if (!(sig == SIGCHLD || sig == SIGALRM || sig == SIGPROF))
109 signal (sig, handler);
111 return old;
114 /* Emulate sigaction. */
116 sigaction (int sig, const struct sigaction *act, struct sigaction *oact)
118 signal_handler old = SIG_DFL;
119 int retval = 0;
121 if (act)
122 old = sys_signal (sig, act->sa_handler);
123 else if (oact)
124 old = sig_handlers[sig];
126 if (old == SIG_ERR)
128 errno = EINVAL;
129 retval = -1;
131 if (oact)
133 oact->sa_handler = old;
134 oact->sa_flags = 0;
135 oact->sa_mask = empty_mask;
137 return retval;
140 /* Emulate signal sets and blocking of signals used by timers. */
143 sigemptyset (sigset_t *set)
145 *set = 0;
146 return 0;
150 sigaddset (sigset_t *set, int signo)
152 if (!set)
154 errno = EINVAL;
155 return -1;
157 if (signo < 0 || signo >= NSIG)
159 errno = EINVAL;
160 return -1;
163 *set |= (1U << signo);
165 return 0;
169 sigfillset (sigset_t *set)
171 if (!set)
173 errno = EINVAL;
174 return -1;
177 *set = 0xFFFFFFFF;
178 return 0;
182 sigprocmask (int how, const sigset_t *set, sigset_t *oset)
184 if (!(how == SIG_BLOCK || how == SIG_UNBLOCK || how == SIG_SETMASK))
186 errno = EINVAL;
187 return -1;
190 if (oset)
191 *oset = sig_mask;
193 if (!set)
194 return 0;
196 switch (how)
198 case SIG_BLOCK:
199 sig_mask |= *set;
200 break;
201 case SIG_SETMASK:
202 sig_mask = *set;
203 break;
204 case SIG_UNBLOCK:
205 /* FIXME: Catch signals that are blocked and reissue them when
206 they are unblocked. Important for SIGALRM and SIGPROF only. */
207 sig_mask &= ~(*set);
208 break;
211 return 0;
215 pthread_sigmask (int how, const sigset_t *set, sigset_t *oset)
217 if (sigprocmask (how, set, oset) == -1)
218 return EINVAL;
219 return 0;
223 sigismember (const sigset_t *set, int signo)
225 if (signo < 0 || signo >= NSIG)
227 errno = EINVAL;
228 return -1;
230 if (signo > sizeof (*set) * BITS_PER_CHAR)
231 emacs_abort ();
233 return (*set & (1U << signo)) != 0;
236 pid_t
237 getpgrp (void)
239 return getpid ();
242 pid_t
243 tcgetpgrp (int fd)
245 return getpid ();
249 setpgid (pid_t pid, pid_t pgid)
251 return 0;
254 pid_t
255 setsid (void)
257 return getpid ();
260 /* Emulations of interval timers.
262 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
264 Implementation: a separate thread is started for each timer type,
265 the thread calls the appropriate signal handler when the timer
266 expires, after stopping the thread which installed the timer. */
268 struct itimer_data {
269 volatile ULONGLONG expire;
270 volatile ULONGLONG reload;
271 volatile int terminate;
272 int type;
273 HANDLE caller_thread;
274 HANDLE timer_thread;
277 static ULONGLONG ticks_now;
278 static struct itimer_data real_itimer, prof_itimer;
279 static ULONGLONG clocks_min;
280 /* If non-zero, itimers are disabled. Used during shutdown, when we
281 delete the critical sections used by the timer threads. */
282 static int disable_itimers;
284 static CRITICAL_SECTION crit_real, crit_prof;
286 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
287 typedef BOOL (WINAPI *GetThreadTimes_Proc) (
288 HANDLE hThread,
289 LPFILETIME lpCreationTime,
290 LPFILETIME lpExitTime,
291 LPFILETIME lpKernelTime,
292 LPFILETIME lpUserTime);
294 static GetThreadTimes_Proc s_pfn_Get_Thread_Times;
296 #define MAX_SINGLE_SLEEP 30
297 #define TIMER_TICKS_PER_SEC 1000
299 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
300 to a thread. If THREAD is NULL or an invalid handle, return the
301 current wall-clock time since January 1, 1601 (UTC). Otherwise,
302 return the sum of kernel and user times used by THREAD since it was
303 created, plus its creation time. */
304 static ULONGLONG
305 w32_get_timer_time (HANDLE thread)
307 ULONGLONG retval;
308 int use_system_time = 1;
309 /* The functions below return times in 100-ns units. */
310 const int tscale = 10 * TIMER_TICKS_PER_SEC;
312 if (thread && thread != INVALID_HANDLE_VALUE
313 && s_pfn_Get_Thread_Times != NULL)
315 FILETIME creation_ftime, exit_ftime, kernel_ftime, user_ftime;
316 ULARGE_INTEGER temp_creation, temp_kernel, temp_user;
318 if (s_pfn_Get_Thread_Times (thread, &creation_ftime, &exit_ftime,
319 &kernel_ftime, &user_ftime))
321 use_system_time = 0;
322 temp_creation.LowPart = creation_ftime.dwLowDateTime;
323 temp_creation.HighPart = creation_ftime.dwHighDateTime;
324 temp_kernel.LowPart = kernel_ftime.dwLowDateTime;
325 temp_kernel.HighPart = kernel_ftime.dwHighDateTime;
326 temp_user.LowPart = user_ftime.dwLowDateTime;
327 temp_user.HighPart = user_ftime.dwHighDateTime;
328 retval =
329 temp_creation.QuadPart / tscale + temp_kernel.QuadPart / tscale
330 + temp_user.QuadPart / tscale;
332 else
333 DebPrint (("GetThreadTimes failed with error code %lu\n",
334 GetLastError ()));
337 if (use_system_time)
339 FILETIME current_ftime;
340 ULARGE_INTEGER temp;
342 GetSystemTimeAsFileTime (&current_ftime);
344 temp.LowPart = current_ftime.dwLowDateTime;
345 temp.HighPart = current_ftime.dwHighDateTime;
347 retval = temp.QuadPart / tscale;
350 return retval;
353 /* Thread function for a timer thread. */
354 static DWORD WINAPI
355 timer_loop (LPVOID arg)
357 struct itimer_data *itimer = (struct itimer_data *)arg;
358 int which = itimer->type;
359 int sig = (which == ITIMER_REAL) ? SIGALRM : SIGPROF;
360 CRITICAL_SECTION *crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
361 const DWORD max_sleep = MAX_SINGLE_SLEEP * 1000 / TIMER_TICKS_PER_SEC;
362 HANDLE hth = (which == ITIMER_REAL) ? NULL : itimer->caller_thread;
364 while (1)
366 DWORD sleep_time;
367 signal_handler handler;
368 ULONGLONG now, expire, reload;
370 /* Load new values if requested by setitimer. */
371 EnterCriticalSection (crit);
372 expire = itimer->expire;
373 reload = itimer->reload;
374 LeaveCriticalSection (crit);
375 if (itimer->terminate)
376 return 0;
378 if (expire == 0)
380 /* We are idle. */
381 Sleep (max_sleep);
382 continue;
385 if (expire > (now = w32_get_timer_time (hth)))
386 sleep_time = expire - now;
387 else
388 sleep_time = 0;
389 /* Don't sleep too long at a time, to be able to see the
390 termination flag without too long a delay. */
391 while (sleep_time > max_sleep)
393 if (itimer->terminate)
394 return 0;
395 Sleep (max_sleep);
396 EnterCriticalSection (crit);
397 expire = itimer->expire;
398 LeaveCriticalSection (crit);
399 sleep_time =
400 (expire > (now = w32_get_timer_time (hth))) ? expire - now : 0;
402 if (itimer->terminate)
403 return 0;
404 if (sleep_time > 0)
406 Sleep (sleep_time * 1000 / TIMER_TICKS_PER_SEC);
407 /* Always sleep past the expiration time, to make sure we
408 never call the handler _before_ the expiration time,
409 always slightly after it. Sleep(5) makes sure we don't
410 hog the CPU by calling 'w32_get_timer_time' with high
411 frequency, and also let other threads work. */
412 while (w32_get_timer_time (hth) < expire)
413 Sleep (5);
416 EnterCriticalSection (crit);
417 expire = itimer->expire;
418 LeaveCriticalSection (crit);
419 if (expire == 0)
420 continue;
422 /* Time's up. */
423 handler = sig_handlers[sig];
424 if (!(handler == SIG_DFL || handler == SIG_IGN || handler == SIG_ERR)
425 /* FIXME: Don't ignore masked signals. Instead, record that
426 they happened and reissue them when the signal is
427 unblocked. */
428 && !sigismember (&sig_mask, sig)
429 /* Simulate masking of SIGALRM and SIGPROF when processing
430 fatal signals. */
431 && !fatal_error_in_progress
432 && itimer->caller_thread)
434 /* Simulate a signal delivered to the thread which installed
435 the timer, by suspending that thread while the handler
436 runs. */
437 HANDLE th = itimer->caller_thread;
438 DWORD result = SuspendThread (th);
440 if (result == (DWORD)-1)
441 return 2;
443 handler (sig);
444 ResumeThread (th);
447 /* Update expiration time and loop. */
448 EnterCriticalSection (crit);
449 expire = itimer->expire;
450 if (expire == 0)
452 LeaveCriticalSection (crit);
453 continue;
455 reload = itimer->reload;
456 if (reload > 0)
458 now = w32_get_timer_time (hth);
459 if (expire <= now)
461 ULONGLONG lag = now - expire;
463 /* If we missed some opportunities (presumably while
464 sleeping or while the signal handler ran), skip
465 them. */
466 if (lag > reload)
467 expire = now - (lag % reload);
469 expire += reload;
472 else
473 expire = 0; /* become idle */
474 itimer->expire = expire;
475 LeaveCriticalSection (crit);
477 return 0;
480 static void
481 stop_timer_thread (int which)
483 struct itimer_data *itimer =
484 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
485 int i;
486 DWORD err, exit_code = 255;
487 BOOL status;
489 /* Signal the thread that it should terminate. */
490 itimer->terminate = 1;
492 if (itimer->timer_thread == NULL)
493 return;
495 /* Wait for the timer thread to terminate voluntarily, then kill it
496 if it doesn't. This loop waits twice more than the maximum
497 amount of time a timer thread sleeps, see above. */
498 for (i = 0; i < MAX_SINGLE_SLEEP / 5; i++)
500 if (!((status = GetExitCodeThread (itimer->timer_thread, &exit_code))
501 && exit_code == STILL_ACTIVE))
502 break;
503 Sleep (10);
505 if ((status == FALSE && (err = GetLastError ()) == ERROR_INVALID_HANDLE)
506 || exit_code == STILL_ACTIVE)
508 if (!(status == FALSE && err == ERROR_INVALID_HANDLE))
509 TerminateThread (itimer->timer_thread, 0);
512 /* Clean up. */
513 CloseHandle (itimer->timer_thread);
514 itimer->timer_thread = NULL;
515 if (itimer->caller_thread)
517 CloseHandle (itimer->caller_thread);
518 itimer->caller_thread = NULL;
522 /* This is called at shutdown time from term_ntproc. */
523 void
524 term_timers (void)
526 if (real_itimer.timer_thread)
527 stop_timer_thread (ITIMER_REAL);
528 if (prof_itimer.timer_thread)
529 stop_timer_thread (ITIMER_PROF);
531 /* We are going to delete the critical sections, so timers cannot
532 work after this. */
533 disable_itimers = 1;
535 DeleteCriticalSection (&crit_real);
536 DeleteCriticalSection (&crit_prof);
537 DeleteCriticalSection (&crit_sig);
540 /* This is called at initialization time from init_ntproc. */
541 void
542 init_timers (void)
544 /* GetThreadTimes is not available on all versions of Windows, so
545 need to probe for its availability dynamically, and call it
546 through a pointer. */
547 s_pfn_Get_Thread_Times = NULL; /* in case dumped Emacs comes with a value */
548 if (os_subtype != OS_9X)
549 s_pfn_Get_Thread_Times =
550 (GetThreadTimes_Proc)GetProcAddress (GetModuleHandle ("kernel32.dll"),
551 "GetThreadTimes");
553 /* Make sure we start with zeroed out itimer structures, since
554 dumping may have left there traces of threads long dead. */
555 memset (&real_itimer, 0, sizeof real_itimer);
556 memset (&prof_itimer, 0, sizeof prof_itimer);
558 InitializeCriticalSection (&crit_real);
559 InitializeCriticalSection (&crit_prof);
560 InitializeCriticalSection (&crit_sig);
562 disable_itimers = 0;
565 static int
566 start_timer_thread (int which)
568 DWORD exit_code;
569 HANDLE th;
570 struct itimer_data *itimer =
571 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
573 if (itimer->timer_thread
574 && GetExitCodeThread (itimer->timer_thread, &exit_code)
575 && exit_code == STILL_ACTIVE)
576 return 0;
578 /* Clean up after possibly exited thread. */
579 if (itimer->timer_thread)
581 CloseHandle (itimer->timer_thread);
582 itimer->timer_thread = NULL;
584 if (itimer->caller_thread)
586 CloseHandle (itimer->caller_thread);
587 itimer->caller_thread = NULL;
590 /* Start a new thread. */
591 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
592 GetCurrentProcess (), &th, 0, FALSE,
593 DUPLICATE_SAME_ACCESS))
595 errno = ESRCH;
596 return -1;
598 itimer->terminate = 0;
599 itimer->type = which;
600 itimer->caller_thread = th;
601 /* Request that no more than 64KB of stack be reserved for this
602 thread, to avoid reserving too much memory, which would get in
603 the way of threads we start to wait for subprocesses. See also
604 new_child below. */
605 itimer->timer_thread = CreateThread (NULL, 64 * 1024, timer_loop,
606 (void *)itimer, 0x00010000, NULL);
608 if (!itimer->timer_thread)
610 CloseHandle (itimer->caller_thread);
611 itimer->caller_thread = NULL;
612 errno = EAGAIN;
613 return -1;
616 /* This is needed to make sure that the timer thread running for
617 profiling gets CPU as soon as the Sleep call terminates. */
618 if (which == ITIMER_PROF)
619 SetThreadPriority (itimer->timer_thread, THREAD_PRIORITY_TIME_CRITICAL);
621 return 0;
624 /* Most of the code of getitimer and setitimer (but not of their
625 subroutines) was shamelessly stolen from itimer.c in the DJGPP
626 library, see www.delorie.com/djgpp. */
628 getitimer (int which, struct itimerval *value)
630 volatile ULONGLONG *t_expire;
631 volatile ULONGLONG *t_reload;
632 ULONGLONG expire, reload;
633 __int64 usecs;
634 CRITICAL_SECTION *crit;
635 struct itimer_data *itimer;
637 if (disable_itimers)
638 return -1;
640 if (!value)
642 errno = EFAULT;
643 return -1;
646 if (which != ITIMER_REAL && which != ITIMER_PROF)
648 errno = EINVAL;
649 return -1;
652 itimer = (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
654 ticks_now = w32_get_timer_time ((which == ITIMER_REAL)
655 ? NULL
656 : GetCurrentThread ());
658 t_expire = &itimer->expire;
659 t_reload = &itimer->reload;
660 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
662 EnterCriticalSection (crit);
663 reload = *t_reload;
664 expire = *t_expire;
665 LeaveCriticalSection (crit);
667 if (expire)
668 expire -= ticks_now;
670 value->it_value.tv_sec = expire / TIMER_TICKS_PER_SEC;
671 usecs =
672 (expire % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
673 value->it_value.tv_usec = usecs;
674 value->it_interval.tv_sec = reload / TIMER_TICKS_PER_SEC;
675 usecs =
676 (reload % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
677 value->it_interval.tv_usec= usecs;
679 return 0;
683 setitimer(int which, struct itimerval *value, struct itimerval *ovalue)
685 volatile ULONGLONG *t_expire, *t_reload;
686 ULONGLONG expire, reload, expire_old, reload_old;
687 __int64 usecs;
688 CRITICAL_SECTION *crit;
689 struct itimerval tem, *ptem;
691 if (disable_itimers)
692 return -1;
694 /* Posix systems expect timer values smaller than the resolution of
695 the system clock be rounded up to the clock resolution. First
696 time we are called, measure the clock tick resolution. */
697 if (!clocks_min)
699 ULONGLONG t1, t2;
701 for (t1 = w32_get_timer_time (NULL);
702 (t2 = w32_get_timer_time (NULL)) == t1; )
704 clocks_min = t2 - t1;
707 if (ovalue)
708 ptem = ovalue;
709 else
710 ptem = &tem;
712 if (getitimer (which, ptem)) /* also sets ticks_now */
713 return -1; /* errno already set */
715 t_expire =
716 (which == ITIMER_REAL) ? &real_itimer.expire : &prof_itimer.expire;
717 t_reload =
718 (which == ITIMER_REAL) ? &real_itimer.reload : &prof_itimer.reload;
720 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
722 if (!value
723 || (value->it_value.tv_sec == 0 && value->it_value.tv_usec == 0))
725 EnterCriticalSection (crit);
726 /* Disable the timer. */
727 *t_expire = 0;
728 *t_reload = 0;
729 LeaveCriticalSection (crit);
730 return 0;
733 reload = value->it_interval.tv_sec * TIMER_TICKS_PER_SEC;
735 usecs = value->it_interval.tv_usec;
736 if (value->it_interval.tv_sec == 0
737 && usecs && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
738 reload = clocks_min;
739 else
741 usecs *= TIMER_TICKS_PER_SEC;
742 reload += usecs / 1000000;
745 expire = value->it_value.tv_sec * TIMER_TICKS_PER_SEC;
746 usecs = value->it_value.tv_usec;
747 if (value->it_value.tv_sec == 0
748 && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
749 expire = clocks_min;
750 else
752 usecs *= TIMER_TICKS_PER_SEC;
753 expire += usecs / 1000000;
756 expire += ticks_now;
758 EnterCriticalSection (crit);
759 expire_old = *t_expire;
760 reload_old = *t_reload;
761 if (!(expire == expire_old && reload == reload_old))
763 *t_reload = reload;
764 *t_expire = expire;
766 LeaveCriticalSection (crit);
768 return start_timer_thread (which);
772 alarm (int seconds)
774 #ifdef HAVE_SETITIMER
775 struct itimerval new_values, old_values;
777 new_values.it_value.tv_sec = seconds;
778 new_values.it_value.tv_usec = 0;
779 new_values.it_interval.tv_sec = new_values.it_interval.tv_usec = 0;
781 if (setitimer (ITIMER_REAL, &new_values, &old_values) < 0)
782 return 0;
783 return old_values.it_value.tv_sec;
784 #else
785 return seconds;
786 #endif
789 /* Defined in <process.h> which conflicts with the local copy */
790 #define _P_NOWAIT 1
792 /* Child process management list. */
793 int child_proc_count = 0;
794 child_process child_procs[ MAX_CHILDREN ];
796 static DWORD WINAPI reader_thread (void *arg);
798 /* Find an unused process slot. */
799 child_process *
800 new_child (void)
802 child_process *cp;
803 DWORD id;
805 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
806 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
807 goto Initialize;
808 if (child_proc_count == MAX_CHILDREN)
810 int i = 0;
811 child_process *dead_cp = NULL;
813 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
814 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
815 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
817 DWORD status = 0;
819 if (!GetExitCodeProcess (cp->procinfo.hProcess, &status))
821 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
822 GetLastError (), cp->procinfo.dwProcessId));
823 status = STILL_ACTIVE;
825 if (status != STILL_ACTIVE
826 || WaitForSingleObject (cp->procinfo.hProcess, 0) == WAIT_OBJECT_0)
828 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
829 cp->procinfo.dwProcessId, cp->fd));
830 CloseHandle (cp->procinfo.hProcess);
831 cp->procinfo.hProcess = NULL;
832 CloseHandle (cp->procinfo.hThread);
833 cp->procinfo.hThread = NULL;
834 /* Free up to 2 dead slots at a time, so that if we
835 have a lot of them, they will eventually all be
836 freed when the tornado ends. */
837 if (i == 0)
838 dead_cp = cp;
839 else
840 break;
841 i++;
844 if (dead_cp)
846 cp = dead_cp;
847 goto Initialize;
850 if (child_proc_count == MAX_CHILDREN)
851 return NULL;
852 cp = &child_procs[child_proc_count++];
854 Initialize:
855 /* Last opportunity to avoid leaking handles before we forget them
856 for good. */
857 if (cp->procinfo.hProcess)
858 CloseHandle (cp->procinfo.hProcess);
859 if (cp->procinfo.hThread)
860 CloseHandle (cp->procinfo.hThread);
861 memset (cp, 0, sizeof (*cp));
862 cp->fd = -1;
863 cp->pid = -1;
864 cp->procinfo.hProcess = NULL;
865 cp->status = STATUS_READ_ERROR;
867 /* use manual reset event so that select() will function properly */
868 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
869 if (cp->char_avail)
871 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
872 if (cp->char_consumed)
874 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
875 It means that the 64K stack we are requesting in the 2nd
876 argument is how much memory should be reserved for the
877 stack. If we don't use this flag, the memory requested
878 by the 2nd argument is the amount actually _committed_,
879 but Windows reserves 8MB of memory for each thread's
880 stack. (The 8MB figure comes from the -stack
881 command-line argument we pass to the linker when building
882 Emacs, but that's because we need a large stack for
883 Emacs's main thread.) Since we request 2GB of reserved
884 memory at startup (see w32heap.c), which is close to the
885 maximum memory available for a 32-bit process on Windows,
886 the 8MB reservation for each thread causes failures in
887 starting subprocesses, because we create a thread running
888 reader_thread for each subprocess. As 8MB of stack is
889 way too much for reader_thread, forcing Windows to
890 reserve less wins the day. */
891 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
892 0x00010000, &id);
893 if (cp->thrd)
894 return cp;
897 delete_child (cp);
898 return NULL;
901 void
902 delete_child (child_process *cp)
904 int i;
906 /* Should not be deleting a child that is still needed. */
907 for (i = 0; i < MAXDESC; i++)
908 if (fd_info[i].cp == cp)
909 emacs_abort ();
911 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
912 return;
914 /* reap thread if necessary */
915 if (cp->thrd)
917 DWORD rc;
919 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
921 /* let the thread exit cleanly if possible */
922 cp->status = STATUS_READ_ERROR;
923 SetEvent (cp->char_consumed);
924 #if 0
925 /* We used to forcibly terminate the thread here, but it
926 is normally unnecessary, and in abnormal cases, the worst that
927 will happen is we have an extra idle thread hanging around
928 waiting for the zombie process. */
929 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
931 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
932 "with %lu for fd %ld\n", GetLastError (), cp->fd));
933 TerminateThread (cp->thrd, 0);
935 #endif
937 CloseHandle (cp->thrd);
938 cp->thrd = NULL;
940 if (cp->char_avail)
942 CloseHandle (cp->char_avail);
943 cp->char_avail = NULL;
945 if (cp->char_consumed)
947 CloseHandle (cp->char_consumed);
948 cp->char_consumed = NULL;
951 /* update child_proc_count (highest numbered slot in use plus one) */
952 if (cp == child_procs + child_proc_count - 1)
954 for (i = child_proc_count-1; i >= 0; i--)
955 if (CHILD_ACTIVE (&child_procs[i])
956 || child_procs[i].procinfo.hProcess != NULL)
958 child_proc_count = i + 1;
959 break;
962 if (i < 0)
963 child_proc_count = 0;
966 /* Find a child by pid. */
967 static child_process *
968 find_child_pid (DWORD pid)
970 child_process *cp;
972 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
973 if ((CHILD_ACTIVE (cp) || cp->procinfo.hProcess != NULL)
974 && pid == cp->pid)
975 return cp;
976 return NULL;
979 void
980 release_listen_threads (void)
982 int i;
984 for (i = child_proc_count - 1; i >= 0; i--)
986 if (CHILD_ACTIVE (&child_procs[i])
987 && (fd_info[child_procs[i].fd].flags & FILE_LISTEN))
988 child_procs[i].status = STATUS_READ_ERROR;
992 /* Thread proc for child process and socket reader threads. Each thread
993 is normally blocked until woken by select() to check for input by
994 reading one char. When the read completes, char_avail is signaled
995 to wake up the select emulator and the thread blocks itself again. */
996 static DWORD WINAPI
997 reader_thread (void *arg)
999 child_process *cp;
1001 /* Our identity */
1002 cp = (child_process *)arg;
1004 /* We have to wait for the go-ahead before we can start */
1005 if (cp == NULL
1006 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
1007 || cp->fd < 0)
1008 return 1;
1010 for (;;)
1012 int rc;
1014 if (cp->fd >= 0 && fd_info[cp->fd].flags & FILE_LISTEN)
1015 rc = _sys_wait_accept (cp->fd);
1016 else
1017 rc = _sys_read_ahead (cp->fd);
1019 /* Don't bother waiting for the event if we already have been
1020 told to exit by delete_child. */
1021 if (cp->status == STATUS_READ_ERROR || !cp->char_avail)
1022 break;
1024 /* The name char_avail is a misnomer - it really just means the
1025 read-ahead has completed, whether successfully or not. */
1026 if (!SetEvent (cp->char_avail))
1028 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1029 (DWORD_PTR)cp->char_avail, GetLastError (),
1030 cp->fd, cp->pid));
1031 return 1;
1034 if (rc == STATUS_READ_ERROR)
1035 return 1;
1037 /* If the read died, the child has died so let the thread die */
1038 if (rc == STATUS_READ_FAILED)
1039 break;
1041 /* Don't bother waiting for the acknowledge if we already have
1042 been told to exit by delete_child. */
1043 if (cp->status == STATUS_READ_ERROR || !cp->char_consumed)
1044 break;
1046 /* Wait until our input is acknowledged before reading again */
1047 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
1049 DebPrint (("reader_thread.WaitForSingleObject failed with "
1050 "%lu for fd %ld\n", GetLastError (), cp->fd));
1051 break;
1053 /* delete_child sets status to STATUS_READ_ERROR when it wants
1054 us to exit. */
1055 if (cp->status == STATUS_READ_ERROR)
1056 break;
1058 return 0;
1061 /* To avoid Emacs changing directory, we just record here the
1062 directory the new process should start in. This is set just before
1063 calling sys_spawnve, and is not generally valid at any other time.
1064 Note that this directory's name is UTF-8 encoded. */
1065 static char * process_dir;
1067 static BOOL
1068 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
1069 int * pPid, child_process *cp)
1071 STARTUPINFO start;
1072 SECURITY_ATTRIBUTES sec_attrs;
1073 #if 0
1074 SECURITY_DESCRIPTOR sec_desc;
1075 #endif
1076 DWORD flags;
1077 char dir[ MAX_PATH ];
1078 char *p;
1080 if (cp == NULL) emacs_abort ();
1082 memset (&start, 0, sizeof (start));
1083 start.cb = sizeof (start);
1085 #ifdef HAVE_NTGUI
1086 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1087 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1088 else
1089 start.dwFlags = STARTF_USESTDHANDLES;
1090 start.wShowWindow = SW_HIDE;
1092 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1093 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1094 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1095 #endif /* HAVE_NTGUI */
1097 #if 0
1098 /* Explicitly specify no security */
1099 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1100 goto EH_Fail;
1101 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1102 goto EH_Fail;
1103 #endif
1104 sec_attrs.nLength = sizeof (sec_attrs);
1105 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1106 sec_attrs.bInheritHandle = FALSE;
1108 filename_to_ansi (process_dir, dir);
1109 /* Can't use unixtodos_filename here, since that needs its file name
1110 argument encoded in UTF-8. OTOH, process_dir, which _is_ in
1111 UTF-8, points, to the directory computed by our caller, and we
1112 don't want to modify that, either. */
1113 for (p = dir; *p; p = CharNextA (p))
1114 if (*p == '/')
1115 *p = '\\';
1117 flags = (!NILP (Vw32_start_process_share_console)
1118 ? CREATE_NEW_PROCESS_GROUP
1119 : CREATE_NEW_CONSOLE);
1120 if (NILP (Vw32_start_process_inherit_error_mode))
1121 flags |= CREATE_DEFAULT_ERROR_MODE;
1122 if (!CreateProcessA (exe, cmdline, &sec_attrs, NULL, TRUE,
1123 flags, env, dir, &start, &cp->procinfo))
1124 goto EH_Fail;
1126 cp->pid = (int) cp->procinfo.dwProcessId;
1128 /* Hack for Windows 95, which assigns large (ie negative) pids */
1129 if (cp->pid < 0)
1130 cp->pid = -cp->pid;
1132 *pPid = cp->pid;
1134 return TRUE;
1136 EH_Fail:
1137 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1138 return FALSE;
1141 /* create_child doesn't know what emacs's file handle will be for waiting
1142 on output from the child, so we need to make this additional call
1143 to register the handle with the process
1144 This way the select emulator knows how to match file handles with
1145 entries in child_procs. */
1146 void
1147 register_child (pid_t pid, int fd)
1149 child_process *cp;
1151 cp = find_child_pid ((DWORD)pid);
1152 if (cp == NULL)
1154 DebPrint (("register_child unable to find pid %lu\n", pid));
1155 return;
1158 #ifdef FULL_DEBUG
1159 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1160 #endif
1162 cp->fd = fd;
1164 /* thread is initially blocked until select is called; set status so
1165 that select will release thread */
1166 cp->status = STATUS_READ_ACKNOWLEDGED;
1168 /* attach child_process to fd_info */
1169 if (fd_info[fd].cp != NULL)
1171 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1172 emacs_abort ();
1175 fd_info[fd].cp = cp;
1178 /* Called from waitpid when a process exits. */
1179 static void
1180 reap_subprocess (child_process *cp)
1182 if (cp->procinfo.hProcess)
1184 /* Reap the process */
1185 #ifdef FULL_DEBUG
1186 /* Process should have already died before we are called. */
1187 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1188 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp->fd));
1189 #endif
1190 CloseHandle (cp->procinfo.hProcess);
1191 cp->procinfo.hProcess = NULL;
1192 CloseHandle (cp->procinfo.hThread);
1193 cp->procinfo.hThread = NULL;
1196 /* If cp->fd was not closed yet, we might be still reading the
1197 process output, so don't free its resources just yet. The call
1198 to delete_child on behalf of this subprocess will be made by
1199 sys_read when the subprocess output is fully read. */
1200 if (cp->fd < 0)
1201 delete_child (cp);
1204 /* Wait for a child process specified by PID, or for any of our
1205 existing child processes (if PID is nonpositive) to die. When it
1206 does, close its handle. Return the pid of the process that died
1207 and fill in STATUS if non-NULL. */
1209 pid_t
1210 waitpid (pid_t pid, int *status, int options)
1212 DWORD active, retval;
1213 int nh;
1214 child_process *cp, *cps[MAX_CHILDREN];
1215 HANDLE wait_hnd[MAX_CHILDREN];
1216 DWORD timeout_ms;
1217 int dont_wait = (options & WNOHANG) != 0;
1219 nh = 0;
1220 /* According to Posix:
1222 PID = -1 means status is requested for any child process.
1224 PID > 0 means status is requested for a single child process
1225 whose pid is PID.
1227 PID = 0 means status is requested for any child process whose
1228 process group ID is equal to that of the calling process. But
1229 since Windows has only a limited support for process groups (only
1230 for console processes and only for the purposes of passing
1231 Ctrl-BREAK signal to them), and since we have no documented way
1232 of determining whether a given process belongs to our group, we
1233 treat 0 as -1.
1235 PID < -1 means status is requested for any child process whose
1236 process group ID is equal to the absolute value of PID. Again,
1237 since we don't support process groups, we treat that as -1. */
1238 if (pid > 0)
1240 int our_child = 0;
1242 /* We are requested to wait for a specific child. */
1243 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1245 /* Some child_procs might be sockets; ignore them. Also
1246 ignore subprocesses whose output is not yet completely
1247 read. */
1248 if (CHILD_ACTIVE (cp)
1249 && cp->procinfo.hProcess
1250 && cp->pid == pid)
1252 our_child = 1;
1253 break;
1256 if (our_child)
1258 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1260 wait_hnd[nh] = cp->procinfo.hProcess;
1261 cps[nh] = cp;
1262 nh++;
1264 else if (dont_wait)
1266 /* PID specifies our subprocess, but its status is not
1267 yet available. */
1268 return 0;
1271 if (nh == 0)
1273 /* No such child process, or nothing to wait for, so fail. */
1274 errno = ECHILD;
1275 return -1;
1278 else
1280 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1282 if (CHILD_ACTIVE (cp)
1283 && cp->procinfo.hProcess
1284 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1286 wait_hnd[nh] = cp->procinfo.hProcess;
1287 cps[nh] = cp;
1288 nh++;
1291 if (nh == 0)
1293 /* Nothing to wait on, so fail. */
1294 errno = ECHILD;
1295 return -1;
1299 if (dont_wait)
1300 timeout_ms = 0;
1301 else
1302 timeout_ms = 1000; /* check for quit about once a second. */
1306 QUIT;
1307 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1308 } while (active == WAIT_TIMEOUT && !dont_wait);
1310 if (active == WAIT_FAILED)
1312 errno = EBADF;
1313 return -1;
1315 else if (active == WAIT_TIMEOUT && dont_wait)
1317 /* PID specifies our subprocess, but it didn't exit yet, so its
1318 status is not yet available. */
1319 #ifdef FULL_DEBUG
1320 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1321 #endif
1322 return 0;
1324 else if (active >= WAIT_OBJECT_0
1325 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1327 active -= WAIT_OBJECT_0;
1329 else if (active >= WAIT_ABANDONED_0
1330 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1332 active -= WAIT_ABANDONED_0;
1334 else
1335 emacs_abort ();
1337 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1339 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1340 GetLastError ()));
1341 retval = 1;
1343 if (retval == STILL_ACTIVE)
1345 /* Should never happen. */
1346 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1347 if (pid > 0 && dont_wait)
1348 return 0;
1349 errno = EINVAL;
1350 return -1;
1353 /* Massage the exit code from the process to match the format expected
1354 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1355 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1357 if (retval == STATUS_CONTROL_C_EXIT)
1358 retval = SIGINT;
1359 else
1360 retval <<= 8;
1362 if (pid > 0 && active != 0)
1363 emacs_abort ();
1364 cp = cps[active];
1365 pid = cp->pid;
1366 #ifdef FULL_DEBUG
1367 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1368 #endif
1370 if (status)
1371 *status = retval;
1372 reap_subprocess (cp);
1374 return pid;
1377 /* Old versions of w32api headers don't have separate 32-bit and
1378 64-bit defines, but the one they have matches the 32-bit variety. */
1379 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1380 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1381 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1382 #endif
1384 /* Implementation note: This function works with file names encoded in
1385 the current ANSI codepage. */
1386 static void
1387 w32_executable_type (char * filename,
1388 int * is_dos_app,
1389 int * is_cygnus_app,
1390 int * is_gui_app)
1392 file_data executable;
1393 char * p;
1395 /* Default values in case we can't tell for sure. */
1396 *is_dos_app = FALSE;
1397 *is_cygnus_app = FALSE;
1398 *is_gui_app = FALSE;
1400 if (!open_input_file (&executable, filename))
1401 return;
1403 p = strrchr (filename, '.');
1405 /* We can only identify DOS .com programs from the extension. */
1406 if (p && xstrcasecmp (p, ".com") == 0)
1407 *is_dos_app = TRUE;
1408 else if (p && (xstrcasecmp (p, ".bat") == 0
1409 || xstrcasecmp (p, ".cmd") == 0))
1411 /* A DOS shell script - it appears that CreateProcess is happy to
1412 accept this (somewhat surprisingly); presumably it looks at
1413 COMSPEC to determine what executable to actually invoke.
1414 Therefore, we have to do the same here as well. */
1415 /* Actually, I think it uses the program association for that
1416 extension, which is defined in the registry. */
1417 p = egetenv ("COMSPEC");
1418 if (p)
1419 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1421 else
1423 /* Look for DOS .exe signature - if found, we must also check that
1424 it isn't really a 16- or 32-bit Windows exe, since both formats
1425 start with a DOS program stub. Note that 16-bit Windows
1426 executables use the OS/2 1.x format. */
1428 IMAGE_DOS_HEADER * dos_header;
1429 IMAGE_NT_HEADERS * nt_header;
1431 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1432 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1433 goto unwind;
1435 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1437 if ((char *) nt_header > (char *) dos_header + executable.size)
1439 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1440 *is_dos_app = TRUE;
1442 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1443 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1445 *is_dos_app = TRUE;
1447 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1449 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1450 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1452 /* Ensure we are using the 32 bit structure. */
1453 IMAGE_OPTIONAL_HEADER32 *opt
1454 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1455 data_dir = opt->DataDirectory;
1456 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1458 /* MingW 3.12 has the required 64 bit structs, but in case older
1459 versions don't, only check 64 bit exes if we know how. */
1460 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1461 else if (nt_header->OptionalHeader.Magic
1462 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1464 IMAGE_OPTIONAL_HEADER64 *opt
1465 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1466 data_dir = opt->DataDirectory;
1467 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1469 #endif
1470 if (data_dir)
1472 /* Look for cygwin.dll in DLL import list. */
1473 IMAGE_DATA_DIRECTORY import_dir =
1474 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1475 IMAGE_IMPORT_DESCRIPTOR * imports;
1476 IMAGE_SECTION_HEADER * section;
1478 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1479 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1480 executable);
1482 for ( ; imports->Name; imports++)
1484 char * dllname = RVA_TO_PTR (imports->Name, section,
1485 executable);
1487 /* The exact name of the cygwin dll has changed with
1488 various releases, but hopefully this will be reasonably
1489 future proof. */
1490 if (strncmp (dllname, "cygwin", 6) == 0)
1492 *is_cygnus_app = TRUE;
1493 break;
1500 unwind:
1501 close_file_data (&executable);
1504 static int
1505 compare_env (const void *strp1, const void *strp2)
1507 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1509 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1511 /* Sort order in command.com/cmd.exe is based on uppercasing
1512 names, so do the same here. */
1513 if (toupper (*str1) > toupper (*str2))
1514 return 1;
1515 else if (toupper (*str1) < toupper (*str2))
1516 return -1;
1517 str1++, str2++;
1520 if (*str1 == '=' && *str2 == '=')
1521 return 0;
1522 else if (*str1 == '=')
1523 return -1;
1524 else
1525 return 1;
1528 static void
1529 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1531 char **optr, **nptr;
1532 int num;
1534 nptr = new_envp;
1535 optr = envp1;
1536 while (*optr)
1537 *nptr++ = *optr++;
1538 num = optr - envp1;
1540 optr = envp2;
1541 while (*optr)
1542 *nptr++ = *optr++;
1543 num += optr - envp2;
1545 qsort (new_envp, num, sizeof (char *), compare_env);
1547 *nptr = NULL;
1550 /* When a new child process is created we need to register it in our list,
1551 so intercept spawn requests. */
1553 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1555 Lisp_Object program, full;
1556 char *cmdline, *env, *parg, **targ;
1557 int arglen, numenv;
1558 pid_t pid;
1559 child_process *cp;
1560 int is_dos_app, is_cygnus_app, is_gui_app;
1561 int do_quoting = 0;
1562 /* We pass our process ID to our children by setting up an environment
1563 variable in their environment. */
1564 char ppid_env_var_buffer[64];
1565 char *extra_env[] = {ppid_env_var_buffer, NULL};
1566 /* These are the characters that cause an argument to need quoting.
1567 Arguments with whitespace characters need quoting to prevent the
1568 argument being split into two or more. Arguments with wildcards
1569 are also quoted, for consistency with posix platforms, where wildcards
1570 are not expanded if we run the program directly without a shell.
1571 Some extra whitespace characters need quoting in Cygwin programs,
1572 so this list is conditionally modified below. */
1573 char *sepchars = " \t*?";
1574 /* This is for native w32 apps; modified below for Cygwin apps. */
1575 char escape_char = '\\';
1576 char cmdname_a[MAX_PATH];
1578 /* We don't care about the other modes */
1579 if (mode != _P_NOWAIT)
1581 errno = EINVAL;
1582 return -1;
1585 /* Handle executable names without an executable suffix. The caller
1586 already searched exec-path and verified the file is executable,
1587 but start-process doesn't do that for file names that are already
1588 absolute. So we double-check this here, just in case. */
1589 if (faccessat (AT_FDCWD, cmdname, X_OK, AT_EACCESS) != 0)
1591 struct gcpro gcpro1;
1593 program = build_string (cmdname);
1594 full = Qnil;
1595 GCPRO1 (program);
1596 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK), 0);
1597 UNGCPRO;
1598 if (NILP (full))
1600 errno = EINVAL;
1601 return -1;
1603 program = ENCODE_FILE (full);
1604 cmdname = SDATA (program);
1607 /* make sure argv[0] and cmdname are both in DOS format */
1608 unixtodos_filename (cmdname);
1609 /* argv[0] was encoded by caller using ENCODE_FILE, so it is in
1610 UTF-8. All the other arguments are encoded by ENCODE_SYSTEM or
1611 some such, and are in some ANSI codepage. We need to have
1612 argv[0] encoded in ANSI codepage. */
1613 filename_to_ansi (cmdname, cmdname_a);
1614 /* We explicitly require that the command's file name be encodable
1615 in the current ANSI codepage, because we will be invoking it via
1616 the ANSI APIs. */
1617 if (_mbspbrk (cmdname_a, "?"))
1619 errno = ENOENT;
1620 return -1;
1622 /* From here on, CMDNAME is an ANSI-encoded string. */
1623 cmdname = cmdname_a;
1624 argv[0] = cmdname;
1626 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1627 executable that is implicitly linked to the Cygnus dll (implying it
1628 was compiled with the Cygnus GNU toolchain and hence relies on
1629 cygwin.dll to parse the command line - we use this to decide how to
1630 escape quote chars in command line args that must be quoted).
1632 Also determine whether it is a GUI app, so that we don't hide its
1633 initial window unless specifically requested. */
1634 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1636 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1637 application to start it by specifying the helper app as cmdname,
1638 while leaving the real app name as argv[0]. */
1639 if (is_dos_app)
1641 char *p;
1643 cmdname = alloca (MAX_PATH);
1644 if (egetenv ("CMDPROXY"))
1645 strcpy (cmdname, egetenv ("CMDPROXY"));
1646 else
1648 strcpy (cmdname, SDATA (Vinvocation_directory));
1649 strcat (cmdname, "cmdproxy.exe");
1652 /* Can't use unixtodos_filename here, since that needs its file
1653 name argument encoded in UTF-8. */
1654 for (p = cmdname; *p; p = CharNextA (p))
1655 if (*p == '/')
1656 *p = '\\';
1659 /* we have to do some conjuring here to put argv and envp into the
1660 form CreateProcess wants... argv needs to be a space separated/null
1661 terminated list of parameters, and envp is a null
1662 separated/double-null terminated list of parameters.
1664 Additionally, zero-length args and args containing whitespace or
1665 quote chars need to be wrapped in double quotes - for this to work,
1666 embedded quotes need to be escaped as well. The aim is to ensure
1667 the child process reconstructs the argv array we start with
1668 exactly, so we treat quotes at the beginning and end of arguments
1669 as embedded quotes.
1671 The w32 GNU-based library from Cygnus doubles quotes to escape
1672 them, while MSVC uses backslash for escaping. (Actually the MSVC
1673 startup code does attempt to recognize doubled quotes and accept
1674 them, but gets it wrong and ends up requiring three quotes to get a
1675 single embedded quote!) So by default we decide whether to use
1676 quote or backslash as the escape character based on whether the
1677 binary is apparently a Cygnus compiled app.
1679 Note that using backslash to escape embedded quotes requires
1680 additional special handling if an embedded quote is already
1681 preceded by backslash, or if an arg requiring quoting ends with
1682 backslash. In such cases, the run of escape characters needs to be
1683 doubled. For consistency, we apply this special handling as long
1684 as the escape character is not quote.
1686 Since we have no idea how large argv and envp are likely to be we
1687 figure out list lengths on the fly and allocate them. */
1689 if (!NILP (Vw32_quote_process_args))
1691 do_quoting = 1;
1692 /* Override escape char by binding w32-quote-process-args to
1693 desired character, or use t for auto-selection. */
1694 if (INTEGERP (Vw32_quote_process_args))
1695 escape_char = XINT (Vw32_quote_process_args);
1696 else
1697 escape_char = is_cygnus_app ? '"' : '\\';
1700 /* Cygwin apps needs quoting a bit more often. */
1701 if (escape_char == '"')
1702 sepchars = "\r\n\t\f '";
1704 /* do argv... */
1705 arglen = 0;
1706 targ = argv;
1707 while (*targ)
1709 char * p = *targ;
1710 int need_quotes = 0;
1711 int escape_char_run = 0;
1713 if (*p == 0)
1714 need_quotes = 1;
1715 for ( ; *p; p++)
1717 if (escape_char == '"' && *p == '\\')
1718 /* If it's a Cygwin app, \ needs to be escaped. */
1719 arglen++;
1720 else if (*p == '"')
1722 /* allow for embedded quotes to be escaped */
1723 arglen++;
1724 need_quotes = 1;
1725 /* handle the case where the embedded quote is already escaped */
1726 if (escape_char_run > 0)
1728 /* To preserve the arg exactly, we need to double the
1729 preceding escape characters (plus adding one to
1730 escape the quote character itself). */
1731 arglen += escape_char_run;
1734 else if (strchr (sepchars, *p) != NULL)
1736 need_quotes = 1;
1739 if (*p == escape_char && escape_char != '"')
1740 escape_char_run++;
1741 else
1742 escape_char_run = 0;
1744 if (need_quotes)
1746 arglen += 2;
1747 /* handle the case where the arg ends with an escape char - we
1748 must not let the enclosing quote be escaped. */
1749 if (escape_char_run > 0)
1750 arglen += escape_char_run;
1752 arglen += strlen (*targ++) + 1;
1754 cmdline = alloca (arglen);
1755 targ = argv;
1756 parg = cmdline;
1757 while (*targ)
1759 char * p = *targ;
1760 int need_quotes = 0;
1762 if (*p == 0)
1763 need_quotes = 1;
1765 if (do_quoting)
1767 for ( ; *p; p++)
1768 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1769 need_quotes = 1;
1771 if (need_quotes)
1773 int escape_char_run = 0;
1774 char * first;
1775 char * last;
1777 p = *targ;
1778 first = p;
1779 last = p + strlen (p) - 1;
1780 *parg++ = '"';
1781 #if 0
1782 /* This version does not escape quotes if they occur at the
1783 beginning or end of the arg - this could lead to incorrect
1784 behavior when the arg itself represents a command line
1785 containing quoted args. I believe this was originally done
1786 as a hack to make some things work, before
1787 `w32-quote-process-args' was added. */
1788 while (*p)
1790 if (*p == '"' && p > first && p < last)
1791 *parg++ = escape_char; /* escape embedded quotes */
1792 *parg++ = *p++;
1794 #else
1795 for ( ; *p; p++)
1797 if (*p == '"')
1799 /* double preceding escape chars if any */
1800 while (escape_char_run > 0)
1802 *parg++ = escape_char;
1803 escape_char_run--;
1805 /* escape all quote chars, even at beginning or end */
1806 *parg++ = escape_char;
1808 else if (escape_char == '"' && *p == '\\')
1809 *parg++ = '\\';
1810 *parg++ = *p;
1812 if (*p == escape_char && escape_char != '"')
1813 escape_char_run++;
1814 else
1815 escape_char_run = 0;
1817 /* double escape chars before enclosing quote */
1818 while (escape_char_run > 0)
1820 *parg++ = escape_char;
1821 escape_char_run--;
1823 #endif
1824 *parg++ = '"';
1826 else
1828 strcpy (parg, *targ);
1829 parg += strlen (*targ);
1831 *parg++ = ' ';
1832 targ++;
1834 *--parg = '\0';
1836 /* and envp... */
1837 arglen = 1;
1838 targ = envp;
1839 numenv = 1; /* for end null */
1840 while (*targ)
1842 arglen += strlen (*targ++) + 1;
1843 numenv++;
1845 /* extra env vars... */
1846 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1847 GetCurrentProcessId ());
1848 arglen += strlen (ppid_env_var_buffer) + 1;
1849 numenv++;
1851 /* merge env passed in and extra env into one, and sort it. */
1852 targ = (char **) alloca (numenv * sizeof (char *));
1853 merge_and_sort_env (envp, extra_env, targ);
1855 /* concatenate env entries. */
1856 env = alloca (arglen);
1857 parg = env;
1858 while (*targ)
1860 strcpy (parg, *targ);
1861 parg += strlen (*targ++);
1862 *parg++ = '\0';
1864 *parg++ = '\0';
1865 *parg = '\0';
1867 cp = new_child ();
1868 if (cp == NULL)
1870 errno = EAGAIN;
1871 return -1;
1874 /* Now create the process. */
1875 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1877 delete_child (cp);
1878 errno = ENOEXEC;
1879 return -1;
1882 return pid;
1885 /* Emulate the select call
1886 Wait for available input on any of the given rfds, or timeout if
1887 a timeout is given and no input is detected
1888 wfds and efds are not supported and must be NULL.
1890 For simplicity, we detect the death of child processes here and
1891 synchronously call the SIGCHLD handler. Since it is possible for
1892 children to be created without a corresponding pipe handle from which
1893 to read output, we wait separately on the process handles as well as
1894 the char_avail events for each process pipe. We only call
1895 wait/reap_process when the process actually terminates.
1897 To reduce the number of places in which Emacs can be hung such that
1898 C-g is not able to interrupt it, we always wait on interrupt_handle
1899 (which is signaled by the input thread when C-g is detected). If we
1900 detect that we were woken up by C-g, we return -1 with errno set to
1901 EINTR as on Unix. */
1903 /* From w32console.c */
1904 extern HANDLE keyboard_handle;
1906 /* From w32xfns.c */
1907 extern HANDLE interrupt_handle;
1909 /* From process.c */
1910 extern int proc_buffered_char[];
1913 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1914 struct timespec *timeout, void *ignored)
1916 SELECT_TYPE orfds;
1917 DWORD timeout_ms, start_time;
1918 int i, nh, nc, nr;
1919 DWORD active;
1920 child_process *cp, *cps[MAX_CHILDREN];
1921 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1922 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1924 timeout_ms =
1925 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1927 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1928 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1930 Sleep (timeout_ms);
1931 return 0;
1934 /* Otherwise, we only handle rfds, so fail otherwise. */
1935 if (rfds == NULL || wfds != NULL || efds != NULL)
1937 errno = EINVAL;
1938 return -1;
1941 orfds = *rfds;
1942 FD_ZERO (rfds);
1943 nr = 0;
1945 /* If interrupt_handle is available and valid, always wait on it, to
1946 detect C-g (quit). */
1947 nh = 0;
1948 if (interrupt_handle && interrupt_handle != INVALID_HANDLE_VALUE)
1950 wait_hnd[0] = interrupt_handle;
1951 fdindex[0] = -1;
1952 nh++;
1955 /* Build a list of pipe handles to wait on. */
1956 for (i = 0; i < nfds; i++)
1957 if (FD_ISSET (i, &orfds))
1959 if (i == 0)
1961 if (keyboard_handle)
1963 /* Handle stdin specially */
1964 wait_hnd[nh] = keyboard_handle;
1965 fdindex[nh] = i;
1966 nh++;
1969 /* Check for any emacs-generated input in the queue since
1970 it won't be detected in the wait */
1971 if (detect_input_pending ())
1973 FD_SET (i, rfds);
1974 return 1;
1976 else if (noninteractive)
1978 if (handle_file_notifications (NULL))
1979 return 1;
1982 else
1984 /* Child process and socket/comm port input. */
1985 cp = fd_info[i].cp;
1986 if (cp)
1988 int current_status = cp->status;
1990 if (current_status == STATUS_READ_ACKNOWLEDGED)
1992 /* Tell reader thread which file handle to use. */
1993 cp->fd = i;
1994 /* Wake up the reader thread for this process */
1995 cp->status = STATUS_READ_READY;
1996 if (!SetEvent (cp->char_consumed))
1997 DebPrint (("sys_select.SetEvent failed with "
1998 "%lu for fd %ld\n", GetLastError (), i));
2001 #ifdef CHECK_INTERLOCK
2002 /* slightly crude cross-checking of interlock between threads */
2004 current_status = cp->status;
2005 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
2007 /* char_avail has been signaled, so status (which may
2008 have changed) should indicate read has completed
2009 but has not been acknowledged. */
2010 current_status = cp->status;
2011 if (current_status != STATUS_READ_SUCCEEDED
2012 && current_status != STATUS_READ_FAILED)
2013 DebPrint (("char_avail set, but read not completed: status %d\n",
2014 current_status));
2016 else
2018 /* char_avail has not been signaled, so status should
2019 indicate that read is in progress; small possibility
2020 that read has completed but event wasn't yet signaled
2021 when we tested it (because a context switch occurred
2022 or if running on separate CPUs). */
2023 if (current_status != STATUS_READ_READY
2024 && current_status != STATUS_READ_IN_PROGRESS
2025 && current_status != STATUS_READ_SUCCEEDED
2026 && current_status != STATUS_READ_FAILED)
2027 DebPrint (("char_avail reset, but read status is bad: %d\n",
2028 current_status));
2030 #endif
2031 wait_hnd[nh] = cp->char_avail;
2032 fdindex[nh] = i;
2033 if (!wait_hnd[nh]) emacs_abort ();
2034 nh++;
2035 #ifdef FULL_DEBUG
2036 DebPrint (("select waiting on child %d fd %d\n",
2037 cp-child_procs, i));
2038 #endif
2040 else
2042 /* Unable to find something to wait on for this fd, skip */
2044 /* Note that this is not a fatal error, and can in fact
2045 happen in unusual circumstances. Specifically, if
2046 sys_spawnve fails, eg. because the program doesn't
2047 exist, and debug-on-error is t so Fsignal invokes a
2048 nested input loop, then the process output pipe is
2049 still included in input_wait_mask with no child_proc
2050 associated with it. (It is removed when the debugger
2051 exits the nested input loop and the error is thrown.) */
2053 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
2058 count_children:
2059 /* Add handles of child processes. */
2060 nc = 0;
2061 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
2062 /* Some child_procs might be sockets; ignore them. Also some
2063 children may have died already, but we haven't finished reading
2064 the process output; ignore them too. */
2065 if ((CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
2066 && (cp->fd < 0
2067 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
2068 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
2071 wait_hnd[nh + nc] = cp->procinfo.hProcess;
2072 cps[nc] = cp;
2073 nc++;
2076 /* Nothing to look for, so we didn't find anything */
2077 if (nh + nc == 0)
2079 if (timeout)
2080 Sleep (timeout_ms);
2081 if (noninteractive)
2083 if (handle_file_notifications (NULL))
2084 return 1;
2086 return 0;
2089 start_time = GetTickCount ();
2091 /* Wait for input or child death to be signaled. If user input is
2092 allowed, then also accept window messages. */
2093 if (FD_ISSET (0, &orfds))
2094 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
2095 QS_ALLINPUT);
2096 else
2097 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
2099 if (active == WAIT_FAILED)
2101 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2102 nh + nc, timeout_ms, GetLastError ()));
2103 /* don't return EBADF - this causes wait_reading_process_output to
2104 abort; WAIT_FAILED is returned when single-stepping under
2105 Windows 95 after switching thread focus in debugger, and
2106 possibly at other times. */
2107 errno = EINTR;
2108 return -1;
2110 else if (active == WAIT_TIMEOUT)
2112 if (noninteractive)
2114 if (handle_file_notifications (NULL))
2115 return 1;
2117 return 0;
2119 else if (active >= WAIT_OBJECT_0
2120 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
2122 active -= WAIT_OBJECT_0;
2124 else if (active >= WAIT_ABANDONED_0
2125 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
2127 active -= WAIT_ABANDONED_0;
2129 else
2130 emacs_abort ();
2132 /* Loop over all handles after active (now officially documented as
2133 being the first signaled handle in the array). We do this to
2134 ensure fairness, so that all channels with data available will be
2135 processed - otherwise higher numbered channels could be starved. */
2138 if (active == nh + nc)
2140 /* There are messages in the lisp thread's queue; we must
2141 drain the queue now to ensure they are processed promptly,
2142 because if we don't do so, we will not be woken again until
2143 further messages arrive.
2145 NB. If ever we allow window message procedures to callback
2146 into lisp, we will need to ensure messages are dispatched
2147 at a safe time for lisp code to be run (*), and we may also
2148 want to provide some hooks in the dispatch loop to cater
2149 for modeless dialogs created by lisp (ie. to register
2150 window handles to pass to IsDialogMessage).
2152 (*) Note that MsgWaitForMultipleObjects above is an
2153 internal dispatch point for messages that are sent to
2154 windows created by this thread. */
2155 if (drain_message_queue ()
2156 /* If drain_message_queue returns non-zero, that means
2157 we received a WM_EMACS_FILENOTIFY message. If this
2158 is a TTY frame, we must signal the caller that keyboard
2159 input is available, so that w32_console_read_socket
2160 will be called to pick up the notifications. If we
2161 don't do that, file notifications will only work when
2162 the Emacs TTY frame has focus. */
2163 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2164 /* they asked for stdin reads */
2165 && FD_ISSET (0, &orfds)
2166 /* the stdin handle is valid */
2167 && keyboard_handle)
2169 FD_SET (0, rfds);
2170 if (nr == 0)
2171 nr = 1;
2174 else if (active >= nh)
2176 cp = cps[active - nh];
2178 /* We cannot always signal SIGCHLD immediately; if we have not
2179 finished reading the process output, we must delay sending
2180 SIGCHLD until we do. */
2182 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2183 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2184 /* SIG_DFL for SIGCHLD is ignore */
2185 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2186 sig_handlers[SIGCHLD] != SIG_IGN)
2188 #ifdef FULL_DEBUG
2189 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2190 cp->pid));
2191 #endif
2192 sig_handlers[SIGCHLD] (SIGCHLD);
2195 else if (fdindex[active] == -1)
2197 /* Quit (C-g) was detected. */
2198 errno = EINTR;
2199 return -1;
2201 else if (fdindex[active] == 0)
2203 /* Keyboard input available */
2204 FD_SET (0, rfds);
2205 nr++;
2207 else
2209 /* must be a socket or pipe - read ahead should have
2210 completed, either succeeding or failing. */
2211 FD_SET (fdindex[active], rfds);
2212 nr++;
2215 /* Even though wait_reading_process_output only reads from at most
2216 one channel, we must process all channels here so that we reap
2217 all children that have died. */
2218 while (++active < nh + nc)
2219 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2220 break;
2221 } while (active < nh + nc);
2223 if (noninteractive)
2225 if (handle_file_notifications (NULL))
2226 nr++;
2229 /* If no input has arrived and timeout hasn't expired, wait again. */
2230 if (nr == 0)
2232 DWORD elapsed = GetTickCount () - start_time;
2234 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2236 if (timeout_ms != INFINITE)
2237 timeout_ms -= elapsed;
2238 goto count_children;
2242 return nr;
2245 /* Substitute for certain kill () operations */
2247 static BOOL CALLBACK
2248 find_child_console (HWND hwnd, LPARAM arg)
2250 child_process * cp = (child_process *) arg;
2251 DWORD thread_id;
2252 DWORD process_id;
2254 thread_id = GetWindowThreadProcessId (hwnd, &process_id);
2255 if (process_id == cp->procinfo.dwProcessId)
2257 char window_class[32];
2259 GetClassName (hwnd, window_class, sizeof (window_class));
2260 if (strcmp (window_class,
2261 (os_subtype == OS_9X)
2262 ? "tty"
2263 : "ConsoleWindowClass") == 0)
2265 cp->hwnd = hwnd;
2266 return FALSE;
2269 /* keep looking */
2270 return TRUE;
2273 /* Emulate 'kill', but only for other processes. */
2275 sys_kill (pid_t pid, int sig)
2277 child_process *cp;
2278 HANDLE proc_hand;
2279 int need_to_free = 0;
2280 int rc = 0;
2282 /* Each process is in its own process group. */
2283 if (pid < 0)
2284 pid = -pid;
2286 /* Only handle signals that will result in the process dying */
2287 if (sig != 0
2288 && sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2290 errno = EINVAL;
2291 return -1;
2294 if (sig == 0)
2296 /* It will take _some_ time before PID 4 or less on Windows will
2297 be Emacs... */
2298 if (pid <= 4)
2300 errno = EPERM;
2301 return -1;
2303 proc_hand = OpenProcess (PROCESS_QUERY_INFORMATION, 0, pid);
2304 if (proc_hand == NULL)
2306 DWORD err = GetLastError ();
2308 switch (err)
2310 case ERROR_ACCESS_DENIED: /* existing process, but access denied */
2311 errno = EPERM;
2312 return -1;
2313 case ERROR_INVALID_PARAMETER: /* process PID does not exist */
2314 errno = ESRCH;
2315 return -1;
2318 else
2319 CloseHandle (proc_hand);
2320 return 0;
2323 cp = find_child_pid (pid);
2324 if (cp == NULL)
2326 /* We were passed a PID of something other than our subprocess.
2327 If that is our own PID, we will send to ourself a message to
2328 close the selected frame, which does not necessarily
2329 terminates Emacs. But then we are not supposed to call
2330 sys_kill with our own PID. */
2331 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2332 if (proc_hand == NULL)
2334 errno = EPERM;
2335 return -1;
2337 need_to_free = 1;
2339 else
2341 proc_hand = cp->procinfo.hProcess;
2342 pid = cp->procinfo.dwProcessId;
2344 /* Try to locate console window for process. */
2345 EnumWindows (find_child_console, (LPARAM) cp);
2348 if (sig == SIGINT || sig == SIGQUIT)
2350 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2352 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2353 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2354 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2355 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2356 HWND foreground_window;
2358 if (break_scan_code == 0)
2360 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2361 vk_break_code = 'C';
2362 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2365 foreground_window = GetForegroundWindow ();
2366 if (foreground_window)
2368 /* NT 5.0, and apparently also Windows 98, will not allow
2369 a Window to be set to foreground directly without the
2370 user's involvement. The workaround is to attach
2371 ourselves to the thread that owns the foreground
2372 window, since that is the only thread that can set the
2373 foreground window. */
2374 DWORD foreground_thread, child_thread;
2375 foreground_thread =
2376 GetWindowThreadProcessId (foreground_window, NULL);
2377 if (foreground_thread == GetCurrentThreadId ()
2378 || !AttachThreadInput (GetCurrentThreadId (),
2379 foreground_thread, TRUE))
2380 foreground_thread = 0;
2382 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2383 if (child_thread == GetCurrentThreadId ()
2384 || !AttachThreadInput (GetCurrentThreadId (),
2385 child_thread, TRUE))
2386 child_thread = 0;
2388 /* Set the foreground window to the child. */
2389 if (SetForegroundWindow (cp->hwnd))
2391 /* Generate keystrokes as if user had typed Ctrl-Break or
2392 Ctrl-C. */
2393 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2394 keybd_event (vk_break_code, break_scan_code,
2395 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2396 keybd_event (vk_break_code, break_scan_code,
2397 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2398 | KEYEVENTF_KEYUP, 0);
2399 keybd_event (VK_CONTROL, control_scan_code,
2400 KEYEVENTF_KEYUP, 0);
2402 /* Sleep for a bit to give time for Emacs frame to respond
2403 to focus change events (if Emacs was active app). */
2404 Sleep (100);
2406 SetForegroundWindow (foreground_window);
2408 /* Detach from the foreground and child threads now that
2409 the foreground switching is over. */
2410 if (foreground_thread)
2411 AttachThreadInput (GetCurrentThreadId (),
2412 foreground_thread, FALSE);
2413 if (child_thread)
2414 AttachThreadInput (GetCurrentThreadId (),
2415 child_thread, FALSE);
2418 /* Ctrl-Break is NT equivalent of SIGINT. */
2419 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2421 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2422 "for pid %lu\n", GetLastError (), pid));
2423 errno = EINVAL;
2424 rc = -1;
2427 else
2429 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2431 #if 1
2432 if (os_subtype == OS_9X)
2435 Another possibility is to try terminating the VDM out-right by
2436 calling the Shell VxD (id 0x17) V86 interface, function #4
2437 "SHELL_Destroy_VM", ie.
2439 mov edx,4
2440 mov ebx,vm_handle
2441 call shellapi
2443 First need to determine the current VM handle, and then arrange for
2444 the shellapi call to be made from the system vm (by using
2445 Switch_VM_and_callback).
2447 Could try to invoke DestroyVM through CallVxD.
2450 #if 0
2451 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2452 to hang when cmdproxy is used in conjunction with
2453 command.com for an interactive shell. Posting
2454 WM_CLOSE pops up a dialog that, when Yes is selected,
2455 does the same thing. TerminateProcess is also less
2456 than ideal in that subprocesses tend to stick around
2457 until the machine is shutdown, but at least it
2458 doesn't freeze the 16-bit subsystem. */
2459 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2460 #endif
2461 if (!TerminateProcess (proc_hand, 0xff))
2463 DebPrint (("sys_kill.TerminateProcess returned %d "
2464 "for pid %lu\n", GetLastError (), pid));
2465 errno = EINVAL;
2466 rc = -1;
2469 else
2470 #endif
2471 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2473 /* Kill the process. On W32 this doesn't kill child processes
2474 so it doesn't work very well for shells which is why it's not
2475 used in every case. */
2476 else if (!TerminateProcess (proc_hand, 0xff))
2478 DebPrint (("sys_kill.TerminateProcess returned %d "
2479 "for pid %lu\n", GetLastError (), pid));
2480 errno = EINVAL;
2481 rc = -1;
2485 if (need_to_free)
2486 CloseHandle (proc_hand);
2488 return rc;
2491 /* The following two routines are used to manipulate stdin, stdout, and
2492 stderr of our child processes.
2494 Assuming that in, out, and err are *not* inheritable, we make them
2495 stdin, stdout, and stderr of the child as follows:
2497 - Save the parent's current standard handles.
2498 - Set the std handles to inheritable duplicates of the ones being passed in.
2499 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2500 NT file handle for a crt file descriptor.)
2501 - Spawn the child, which inherits in, out, and err as stdin,
2502 stdout, and stderr. (see Spawnve)
2503 - Close the std handles passed to the child.
2504 - Reset the parent's standard handles to the saved handles.
2505 (see reset_standard_handles)
2506 We assume that the caller closes in, out, and err after calling us. */
2508 void
2509 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2511 HANDLE parent;
2512 HANDLE newstdin, newstdout, newstderr;
2514 parent = GetCurrentProcess ();
2516 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2517 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2518 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2520 /* make inheritable copies of the new handles */
2521 if (!DuplicateHandle (parent,
2522 (HANDLE) _get_osfhandle (in),
2523 parent,
2524 &newstdin,
2526 TRUE,
2527 DUPLICATE_SAME_ACCESS))
2528 report_file_error ("Duplicating input handle for child", Qnil);
2530 if (!DuplicateHandle (parent,
2531 (HANDLE) _get_osfhandle (out),
2532 parent,
2533 &newstdout,
2535 TRUE,
2536 DUPLICATE_SAME_ACCESS))
2537 report_file_error ("Duplicating output handle for child", Qnil);
2539 if (!DuplicateHandle (parent,
2540 (HANDLE) _get_osfhandle (err),
2541 parent,
2542 &newstderr,
2544 TRUE,
2545 DUPLICATE_SAME_ACCESS))
2546 report_file_error ("Duplicating error handle for child", Qnil);
2548 /* and store them as our std handles */
2549 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2550 report_file_error ("Changing stdin handle", Qnil);
2552 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2553 report_file_error ("Changing stdout handle", Qnil);
2555 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2556 report_file_error ("Changing stderr handle", Qnil);
2559 void
2560 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2562 /* close the duplicated handles passed to the child */
2563 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2564 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2565 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2567 /* now restore parent's saved std handles */
2568 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2569 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2570 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2573 void
2574 set_process_dir (char * dir)
2576 process_dir = dir;
2579 /* To avoid problems with winsock implementations that work over dial-up
2580 connections causing or requiring a connection to exist while Emacs is
2581 running, Emacs no longer automatically loads winsock on startup if it
2582 is present. Instead, it will be loaded when open-network-stream is
2583 first called.
2585 To allow full control over when winsock is loaded, we provide these
2586 two functions to dynamically load and unload winsock. This allows
2587 dial-up users to only be connected when they actually need to use
2588 socket services. */
2590 /* From w32.c */
2591 extern HANDLE winsock_lib;
2592 extern BOOL term_winsock (void);
2593 extern BOOL init_winsock (int load_now);
2595 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2596 doc: /* Test for presence of the Windows socket library `winsock'.
2597 Returns non-nil if winsock support is present, nil otherwise.
2599 If the optional argument LOAD-NOW is non-nil, the winsock library is
2600 also loaded immediately if not already loaded. If winsock is loaded,
2601 the winsock local hostname is returned (since this may be different from
2602 the value of `system-name' and should supplant it), otherwise t is
2603 returned to indicate winsock support is present. */)
2604 (Lisp_Object load_now)
2606 int have_winsock;
2608 have_winsock = init_winsock (!NILP (load_now));
2609 if (have_winsock)
2611 if (winsock_lib != NULL)
2613 /* Return new value for system-name. The best way to do this
2614 is to call init_system_name, saving and restoring the
2615 original value to avoid side-effects. */
2616 Lisp_Object orig_hostname = Vsystem_name;
2617 Lisp_Object hostname;
2619 init_system_name ();
2620 hostname = Vsystem_name;
2621 Vsystem_name = orig_hostname;
2622 return hostname;
2624 return Qt;
2626 return Qnil;
2629 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2630 0, 0, 0,
2631 doc: /* Unload the Windows socket library `winsock' if loaded.
2632 This is provided to allow dial-up socket connections to be disconnected
2633 when no longer needed. Returns nil without unloading winsock if any
2634 socket connections still exist. */)
2635 (void)
2637 return term_winsock () ? Qt : Qnil;
2641 /* Some miscellaneous functions that are Windows specific, but not GUI
2642 specific (ie. are applicable in terminal or batch mode as well). */
2644 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2645 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2646 If FILENAME does not exist, return nil.
2647 All path elements in FILENAME are converted to their short names. */)
2648 (Lisp_Object filename)
2650 char shortname[MAX_PATH];
2652 CHECK_STRING (filename);
2654 /* first expand it. */
2655 filename = Fexpand_file_name (filename, Qnil);
2657 /* luckily, this returns the short version of each element in the path. */
2658 if (w32_get_short_filename (SDATA (ENCODE_FILE (filename)),
2659 shortname, MAX_PATH) == 0)
2660 return Qnil;
2662 dostounix_filename (shortname);
2664 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2665 return build_string (shortname);
2669 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2670 1, 1, 0,
2671 doc: /* Return the long file name version of the full path of FILENAME.
2672 If FILENAME does not exist, return nil.
2673 All path elements in FILENAME are converted to their long names. */)
2674 (Lisp_Object filename)
2676 char longname[ MAX_UTF8_PATH ];
2677 int drive_only = 0;
2679 CHECK_STRING (filename);
2681 if (SBYTES (filename) == 2
2682 && *(SDATA (filename) + 1) == ':')
2683 drive_only = 1;
2685 /* first expand it. */
2686 filename = Fexpand_file_name (filename, Qnil);
2688 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname,
2689 MAX_UTF8_PATH))
2690 return Qnil;
2692 dostounix_filename (longname);
2694 /* If we were passed only a drive, make sure that a slash is not appended
2695 for consistency with directories. Allow for drive mapping via SUBST
2696 in case expand-file-name is ever changed to expand those. */
2697 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2698 longname[2] = '\0';
2700 return DECODE_FILE (build_unibyte_string (longname));
2703 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2704 Sw32_set_process_priority, 2, 2, 0,
2705 doc: /* Set the priority of PROCESS to PRIORITY.
2706 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2707 priority of the process whose pid is PROCESS is changed.
2708 PRIORITY should be one of the symbols high, normal, or low;
2709 any other symbol will be interpreted as normal.
2711 If successful, the return value is t, otherwise nil. */)
2712 (Lisp_Object process, Lisp_Object priority)
2714 HANDLE proc_handle = GetCurrentProcess ();
2715 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2716 Lisp_Object result = Qnil;
2718 CHECK_SYMBOL (priority);
2720 if (!NILP (process))
2722 DWORD pid;
2723 child_process *cp;
2725 CHECK_NUMBER (process);
2727 /* Allow pid to be an internally generated one, or one obtained
2728 externally. This is necessary because real pids on Windows 95 are
2729 negative. */
2731 pid = XINT (process);
2732 cp = find_child_pid (pid);
2733 if (cp != NULL)
2734 pid = cp->procinfo.dwProcessId;
2736 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2739 if (EQ (priority, Qhigh))
2740 priority_class = HIGH_PRIORITY_CLASS;
2741 else if (EQ (priority, Qlow))
2742 priority_class = IDLE_PRIORITY_CLASS;
2744 if (proc_handle != NULL)
2746 if (SetPriorityClass (proc_handle, priority_class))
2747 result = Qt;
2748 if (!NILP (process))
2749 CloseHandle (proc_handle);
2752 return result;
2755 #ifdef HAVE_LANGINFO_CODESET
2756 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2757 char *
2758 nl_langinfo (nl_item item)
2760 /* Conversion of Posix item numbers to their Windows equivalents. */
2761 static const LCTYPE w32item[] = {
2762 LOCALE_IDEFAULTANSICODEPAGE,
2763 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2764 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2765 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2766 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2767 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2768 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2771 static char *nl_langinfo_buf = NULL;
2772 static int nl_langinfo_len = 0;
2774 if (nl_langinfo_len <= 0)
2775 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2777 if (item < 0 || item >= _NL_NUM)
2778 nl_langinfo_buf[0] = 0;
2779 else
2781 LCID cloc = GetThreadLocale ();
2782 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2783 NULL, 0);
2785 if (need_len <= 0)
2786 nl_langinfo_buf[0] = 0;
2787 else
2789 if (item == CODESET)
2791 need_len += 2; /* for the "cp" prefix */
2792 if (need_len < 8) /* for the case we call GetACP */
2793 need_len = 8;
2795 if (nl_langinfo_len <= need_len)
2796 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2797 nl_langinfo_len = need_len);
2798 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2799 nl_langinfo_buf, nl_langinfo_len))
2800 nl_langinfo_buf[0] = 0;
2801 else if (item == CODESET)
2803 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2804 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2805 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2806 else
2808 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2809 strlen (nl_langinfo_buf) + 1);
2810 nl_langinfo_buf[0] = 'c';
2811 nl_langinfo_buf[1] = 'p';
2816 return nl_langinfo_buf;
2818 #endif /* HAVE_LANGINFO_CODESET */
2820 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2821 Sw32_get_locale_info, 1, 2, 0,
2822 doc: /* Return information about the Windows locale LCID.
2823 By default, return a three letter locale code which encodes the default
2824 language as the first two characters, and the country or regional variant
2825 as the third letter. For example, ENU refers to `English (United States)',
2826 while ENC means `English (Canadian)'.
2828 If the optional argument LONGFORM is t, the long form of the locale
2829 name is returned, e.g. `English (United States)' instead; if LONGFORM
2830 is a number, it is interpreted as an LCTYPE constant and the corresponding
2831 locale information is returned.
2833 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2834 (Lisp_Object lcid, Lisp_Object longform)
2836 int got_abbrev;
2837 int got_full;
2838 char abbrev_name[32] = { 0 };
2839 char full_name[256] = { 0 };
2841 CHECK_NUMBER (lcid);
2843 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2844 return Qnil;
2846 if (NILP (longform))
2848 got_abbrev = GetLocaleInfo (XINT (lcid),
2849 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2850 abbrev_name, sizeof (abbrev_name));
2851 if (got_abbrev)
2852 return build_string (abbrev_name);
2854 else if (EQ (longform, Qt))
2856 got_full = GetLocaleInfo (XINT (lcid),
2857 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2858 full_name, sizeof (full_name));
2859 if (got_full)
2860 return DECODE_SYSTEM (build_string (full_name));
2862 else if (NUMBERP (longform))
2864 got_full = GetLocaleInfo (XINT (lcid),
2865 XINT (longform),
2866 full_name, sizeof (full_name));
2867 /* GetLocaleInfo's return value includes the terminating null
2868 character, when the returned information is a string, whereas
2869 make_unibyte_string needs the string length without the
2870 terminating null. */
2871 if (got_full)
2872 return make_unibyte_string (full_name, got_full - 1);
2875 return Qnil;
2879 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2880 Sw32_get_current_locale_id, 0, 0, 0,
2881 doc: /* Return Windows locale id for current locale setting.
2882 This is a numerical value; use `w32-get-locale-info' to convert to a
2883 human-readable form. */)
2884 (void)
2886 return make_number (GetThreadLocale ());
2889 static DWORD
2890 int_from_hex (char * s)
2892 DWORD val = 0;
2893 static char hex[] = "0123456789abcdefABCDEF";
2894 char * p;
2896 while (*s && (p = strchr (hex, *s)) != NULL)
2898 unsigned digit = p - hex;
2899 if (digit > 15)
2900 digit -= 6;
2901 val = val * 16 + digit;
2902 s++;
2904 return val;
2907 /* We need to build a global list, since the EnumSystemLocale callback
2908 function isn't given a context pointer. */
2909 Lisp_Object Vw32_valid_locale_ids;
2911 static BOOL CALLBACK
2912 enum_locale_fn (LPTSTR localeNum)
2914 DWORD id = int_from_hex (localeNum);
2915 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2916 return TRUE;
2919 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2920 Sw32_get_valid_locale_ids, 0, 0, 0,
2921 doc: /* Return list of all valid Windows locale ids.
2922 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2923 human-readable form. */)
2924 (void)
2926 Vw32_valid_locale_ids = Qnil;
2928 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2930 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2931 return Vw32_valid_locale_ids;
2935 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2936 doc: /* Return Windows locale id for default locale setting.
2937 By default, the system default locale setting is returned; if the optional
2938 parameter USERP is non-nil, the user default locale setting is returned.
2939 This is a numerical value; use `w32-get-locale-info' to convert to a
2940 human-readable form. */)
2941 (Lisp_Object userp)
2943 if (NILP (userp))
2944 return make_number (GetSystemDefaultLCID ());
2945 return make_number (GetUserDefaultLCID ());
2949 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2950 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2951 If successful, the new locale id is returned, otherwise nil. */)
2952 (Lisp_Object lcid)
2954 CHECK_NUMBER (lcid);
2956 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2957 return Qnil;
2959 if (!SetThreadLocale (XINT (lcid)))
2960 return Qnil;
2962 /* Need to set input thread locale if present. */
2963 if (dwWindowsThreadId)
2964 /* Reply is not needed. */
2965 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2967 return make_number (GetThreadLocale ());
2971 /* We need to build a global list, since the EnumCodePages callback
2972 function isn't given a context pointer. */
2973 Lisp_Object Vw32_valid_codepages;
2975 static BOOL CALLBACK
2976 enum_codepage_fn (LPTSTR codepageNum)
2978 DWORD id = atoi (codepageNum);
2979 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2980 return TRUE;
2983 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
2984 Sw32_get_valid_codepages, 0, 0, 0,
2985 doc: /* Return list of all valid Windows codepages. */)
2986 (void)
2988 Vw32_valid_codepages = Qnil;
2990 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
2992 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
2993 return Vw32_valid_codepages;
2997 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
2998 Sw32_get_console_codepage, 0, 0, 0,
2999 doc: /* Return current Windows codepage for console input. */)
3000 (void)
3002 return make_number (GetConsoleCP ());
3006 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
3007 Sw32_set_console_codepage, 1, 1, 0,
3008 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
3009 This codepage setting affects keyboard input in tty mode.
3010 If successful, the new CP is returned, otherwise nil. */)
3011 (Lisp_Object cp)
3013 CHECK_NUMBER (cp);
3015 if (!IsValidCodePage (XINT (cp)))
3016 return Qnil;
3018 if (!SetConsoleCP (XINT (cp)))
3019 return Qnil;
3021 return make_number (GetConsoleCP ());
3025 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
3026 Sw32_get_console_output_codepage, 0, 0, 0,
3027 doc: /* Return current Windows codepage for console output. */)
3028 (void)
3030 return make_number (GetConsoleOutputCP ());
3034 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
3035 Sw32_set_console_output_codepage, 1, 1, 0,
3036 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
3037 This codepage setting affects display in tty mode.
3038 If successful, the new CP is returned, otherwise nil. */)
3039 (Lisp_Object cp)
3041 CHECK_NUMBER (cp);
3043 if (!IsValidCodePage (XINT (cp)))
3044 return Qnil;
3046 if (!SetConsoleOutputCP (XINT (cp)))
3047 return Qnil;
3049 return make_number (GetConsoleOutputCP ());
3053 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
3054 Sw32_get_codepage_charset, 1, 1, 0,
3055 doc: /* Return charset ID corresponding to codepage CP.
3056 Returns nil if the codepage is not valid. */)
3057 (Lisp_Object cp)
3059 CHARSETINFO info;
3061 CHECK_NUMBER (cp);
3063 if (!IsValidCodePage (XINT (cp)))
3064 return Qnil;
3066 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
3067 return make_number (info.ciCharset);
3069 return Qnil;
3073 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
3074 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
3075 doc: /* Return list of Windows keyboard languages and layouts.
3076 The return value is a list of pairs of language id and layout id. */)
3077 (void)
3079 int num_layouts = GetKeyboardLayoutList (0, NULL);
3080 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
3081 Lisp_Object obj = Qnil;
3083 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
3085 while (--num_layouts >= 0)
3087 DWORD kl = (DWORD) layouts[num_layouts];
3089 obj = Fcons (Fcons (make_number (kl & 0xffff),
3090 make_number ((kl >> 16) & 0xffff)),
3091 obj);
3095 return obj;
3099 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
3100 Sw32_get_keyboard_layout, 0, 0, 0,
3101 doc: /* Return current Windows keyboard language and layout.
3102 The return value is the cons of the language id and the layout id. */)
3103 (void)
3105 DWORD kl = (DWORD) GetKeyboardLayout (dwWindowsThreadId);
3107 return Fcons (make_number (kl & 0xffff),
3108 make_number ((kl >> 16) & 0xffff));
3112 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
3113 Sw32_set_keyboard_layout, 1, 1, 0,
3114 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
3115 The keyboard layout setting affects interpretation of keyboard input.
3116 If successful, the new layout id is returned, otherwise nil. */)
3117 (Lisp_Object layout)
3119 DWORD kl;
3121 CHECK_CONS (layout);
3122 CHECK_NUMBER_CAR (layout);
3123 CHECK_NUMBER_CDR (layout);
3125 kl = (XINT (XCAR (layout)) & 0xffff)
3126 | (XINT (XCDR (layout)) << 16);
3128 /* Synchronize layout with input thread. */
3129 if (dwWindowsThreadId)
3131 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
3132 (WPARAM) kl, 0))
3134 MSG msg;
3135 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3137 if (msg.wParam == 0)
3138 return Qnil;
3141 else if (!ActivateKeyboardLayout ((HKL) kl, 0))
3142 return Qnil;
3144 return Fw32_get_keyboard_layout ();
3148 void
3149 syms_of_ntproc (void)
3151 DEFSYM (Qhigh, "high");
3152 DEFSYM (Qlow, "low");
3154 defsubr (&Sw32_has_winsock);
3155 defsubr (&Sw32_unload_winsock);
3157 defsubr (&Sw32_short_file_name);
3158 defsubr (&Sw32_long_file_name);
3159 defsubr (&Sw32_set_process_priority);
3160 defsubr (&Sw32_get_locale_info);
3161 defsubr (&Sw32_get_current_locale_id);
3162 defsubr (&Sw32_get_default_locale_id);
3163 defsubr (&Sw32_get_valid_locale_ids);
3164 defsubr (&Sw32_set_current_locale);
3166 defsubr (&Sw32_get_console_codepage);
3167 defsubr (&Sw32_set_console_codepage);
3168 defsubr (&Sw32_get_console_output_codepage);
3169 defsubr (&Sw32_set_console_output_codepage);
3170 defsubr (&Sw32_get_valid_codepages);
3171 defsubr (&Sw32_get_codepage_charset);
3173 defsubr (&Sw32_get_valid_keyboard_layouts);
3174 defsubr (&Sw32_get_keyboard_layout);
3175 defsubr (&Sw32_set_keyboard_layout);
3177 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3178 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3179 Because Windows does not directly pass argv arrays to child processes,
3180 programs have to reconstruct the argv array by parsing the command
3181 line string. For an argument to contain a space, it must be enclosed
3182 in double quotes or it will be parsed as multiple arguments.
3184 If the value is a character, that character will be used to escape any
3185 quote characters that appear, otherwise a suitable escape character
3186 will be chosen based on the type of the program. */);
3187 Vw32_quote_process_args = Qt;
3189 DEFVAR_LISP ("w32-start-process-show-window",
3190 Vw32_start_process_show_window,
3191 doc: /* When nil, new child processes hide their windows.
3192 When non-nil, they show their window in the method of their choice.
3193 This variable doesn't affect GUI applications, which will never be hidden. */);
3194 Vw32_start_process_show_window = Qnil;
3196 DEFVAR_LISP ("w32-start-process-share-console",
3197 Vw32_start_process_share_console,
3198 doc: /* When nil, new child processes are given a new console.
3199 When non-nil, they share the Emacs console; this has the limitation of
3200 allowing only one DOS subprocess to run at a time (whether started directly
3201 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3202 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3203 otherwise respond to interrupts from Emacs. */);
3204 Vw32_start_process_share_console = Qnil;
3206 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3207 Vw32_start_process_inherit_error_mode,
3208 doc: /* When nil, new child processes revert to the default error mode.
3209 When non-nil, they inherit their error mode setting from Emacs, which stops
3210 them blocking when trying to access unmounted drives etc. */);
3211 Vw32_start_process_inherit_error_mode = Qt;
3213 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3214 doc: /* Forced delay before reading subprocess output.
3215 This is done to improve the buffering of subprocess output, by
3216 avoiding the inefficiency of frequently reading small amounts of data.
3218 If positive, the value is the number of milliseconds to sleep before
3219 reading the subprocess output. If negative, the magnitude is the number
3220 of time slices to wait (effectively boosting the priority of the child
3221 process temporarily). A value of zero disables waiting entirely. */);
3222 w32_pipe_read_delay = 50;
3224 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3225 doc: /* Non-nil means convert all-upper case file names to lower case.
3226 This applies when performing completions and file name expansion.
3227 Note that the value of this setting also affects remote file names,
3228 so you probably don't want to set to non-nil if you use case-sensitive
3229 filesystems via ange-ftp. */);
3230 Vw32_downcase_file_names = Qnil;
3232 #if 0
3233 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3234 doc: /* Non-nil means attempt to fake realistic inode values.
3235 This works by hashing the truename of files, and should detect
3236 aliasing between long and short (8.3 DOS) names, but can have
3237 false positives because of hash collisions. Note that determining
3238 the truename of a file can be slow. */);
3239 Vw32_generate_fake_inodes = Qnil;
3240 #endif
3242 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3243 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3244 This option controls whether to issue additional system calls to determine
3245 accurate link counts, file type, and ownership information. It is more
3246 useful for files on NTFS volumes, where hard links and file security are
3247 supported, than on volumes of the FAT family.
3249 Without these system calls, link count will always be reported as 1 and file
3250 ownership will be attributed to the current user.
3251 The default value `local' means only issue these system calls for files
3252 on local fixed drives. A value of nil means never issue them.
3253 Any other non-nil value means do this even on remote and removable drives
3254 where the performance impact may be noticeable even on modern hardware. */);
3255 Vw32_get_true_file_attributes = Qlocal;
3257 staticpro (&Vw32_valid_locale_ids);
3258 staticpro (&Vw32_valid_codepages);
3260 /* end of w32proc.c */