Update copyright year to 2015
[emacs.git] / src / w32proc.c
blob0c178e7a2f63bb9f7c9ca689c9c2b17e74c8c7ae
1 /* Process support for GNU Emacs on the Microsoft Windows API.
3 Copyright (C) 1992, 1995, 1999-2015 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>
35 #include <locale.h>
37 /* must include CRT headers *before* config.h */
38 #include <config.h>
40 #undef signal
41 #undef wait
42 #undef spawnve
43 #undef select
44 #undef kill
46 #include <windows.h>
47 #if defined(__GNUC__) && !defined(__MINGW64__)
48 /* This definition is missing from mingw.org headers, but not MinGW64
49 headers. */
50 extern BOOL WINAPI IsValidLocale (LCID, DWORD);
51 #endif
53 #ifdef HAVE_LANGINFO_CODESET
54 #include <nl_types.h>
55 #include <langinfo.h>
56 #endif
58 #include "lisp.h"
59 #include "w32.h"
60 #include "w32common.h"
61 #include "w32heap.h"
62 #include "systime.h"
63 #include "syswait.h"
64 #include "process.h"
65 #include "syssignal.h"
66 #include "w32term.h"
67 #include "dispextern.h" /* for xstrcasecmp */
68 #include "coding.h"
70 #define RVA_TO_PTR(var,section,filedata) \
71 ((void *)((section)->PointerToRawData \
72 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
73 + (filedata).file_base))
75 Lisp_Object Qhigh, Qlow;
77 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
78 static signal_handler sig_handlers[NSIG];
80 static sigset_t sig_mask;
82 static CRITICAL_SECTION crit_sig;
84 /* Improve on the CRT 'signal' implementation so that we could record
85 the SIGCHLD handler and fake interval timers. */
86 signal_handler
87 sys_signal (int sig, signal_handler handler)
89 signal_handler old;
91 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
92 below. SIGALRM and SIGPROF are used by setitimer. All the
93 others are the only ones supported by the MS runtime. */
94 if (!(sig == SIGCHLD || sig == SIGSEGV || sig == SIGILL
95 || sig == SIGFPE || sig == SIGABRT || sig == SIGTERM
96 || sig == SIGALRM || sig == SIGPROF))
98 errno = EINVAL;
99 return SIG_ERR;
101 old = sig_handlers[sig];
102 /* SIGABRT is treated specially because w32.c installs term_ntproc
103 as its handler, so we don't want to override that afterwards.
104 Aborting Emacs works specially anyway: either by calling
105 emacs_abort directly or through terminate_due_to_signal, which
106 calls emacs_abort through emacs_raise. */
107 if (!(sig == SIGABRT && old == term_ntproc))
109 sig_handlers[sig] = handler;
110 if (!(sig == SIGCHLD || sig == SIGALRM || sig == SIGPROF))
111 signal (sig, handler);
113 return old;
116 /* Emulate sigaction. */
118 sigaction (int sig, const struct sigaction *act, struct sigaction *oact)
120 signal_handler old = SIG_DFL;
121 int retval = 0;
123 if (act)
124 old = sys_signal (sig, act->sa_handler);
125 else if (oact)
126 old = sig_handlers[sig];
128 if (old == SIG_ERR)
130 errno = EINVAL;
131 retval = -1;
133 if (oact)
135 oact->sa_handler = old;
136 oact->sa_flags = 0;
137 oact->sa_mask = empty_mask;
139 return retval;
142 /* Emulate signal sets and blocking of signals used by timers. */
145 sigemptyset (sigset_t *set)
147 *set = 0;
148 return 0;
152 sigaddset (sigset_t *set, int signo)
154 if (!set)
156 errno = EINVAL;
157 return -1;
159 if (signo < 0 || signo >= NSIG)
161 errno = EINVAL;
162 return -1;
165 *set |= (1U << signo);
167 return 0;
171 sigfillset (sigset_t *set)
173 if (!set)
175 errno = EINVAL;
176 return -1;
179 *set = 0xFFFFFFFF;
180 return 0;
184 sigprocmask (int how, const sigset_t *set, sigset_t *oset)
186 if (!(how == SIG_BLOCK || how == SIG_UNBLOCK || how == SIG_SETMASK))
188 errno = EINVAL;
189 return -1;
192 if (oset)
193 *oset = sig_mask;
195 if (!set)
196 return 0;
198 switch (how)
200 case SIG_BLOCK:
201 sig_mask |= *set;
202 break;
203 case SIG_SETMASK:
204 sig_mask = *set;
205 break;
206 case SIG_UNBLOCK:
207 /* FIXME: Catch signals that are blocked and reissue them when
208 they are unblocked. Important for SIGALRM and SIGPROF only. */
209 sig_mask &= ~(*set);
210 break;
213 return 0;
217 pthread_sigmask (int how, const sigset_t *set, sigset_t *oset)
219 if (sigprocmask (how, set, oset) == -1)
220 return EINVAL;
221 return 0;
225 sigismember (const sigset_t *set, int signo)
227 if (signo < 0 || signo >= NSIG)
229 errno = EINVAL;
230 return -1;
232 if (signo > sizeof (*set) * BITS_PER_CHAR)
233 emacs_abort ();
235 return (*set & (1U << signo)) != 0;
238 pid_t
239 getpgrp (void)
241 return getpid ();
244 pid_t
245 tcgetpgrp (int fd)
247 return getpid ();
251 setpgid (pid_t pid, pid_t pgid)
253 return 0;
256 pid_t
257 setsid (void)
259 return getpid ();
262 /* Emulations of interval timers.
264 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
266 Implementation: a separate thread is started for each timer type,
267 the thread calls the appropriate signal handler when the timer
268 expires, after stopping the thread which installed the timer. */
270 struct itimer_data {
271 volatile ULONGLONG expire;
272 volatile ULONGLONG reload;
273 volatile int terminate;
274 int type;
275 HANDLE caller_thread;
276 HANDLE timer_thread;
279 static ULONGLONG ticks_now;
280 static struct itimer_data real_itimer, prof_itimer;
281 static ULONGLONG clocks_min;
282 /* If non-zero, itimers are disabled. Used during shutdown, when we
283 delete the critical sections used by the timer threads. */
284 static int disable_itimers;
286 static CRITICAL_SECTION crit_real, crit_prof;
288 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
289 typedef BOOL (WINAPI *GetThreadTimes_Proc) (
290 HANDLE hThread,
291 LPFILETIME lpCreationTime,
292 LPFILETIME lpExitTime,
293 LPFILETIME lpKernelTime,
294 LPFILETIME lpUserTime);
296 static GetThreadTimes_Proc s_pfn_Get_Thread_Times;
298 #define MAX_SINGLE_SLEEP 30
299 #define TIMER_TICKS_PER_SEC 1000
301 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
302 to a thread. If THREAD is NULL or an invalid handle, return the
303 current wall-clock time since January 1, 1601 (UTC). Otherwise,
304 return the sum of kernel and user times used by THREAD since it was
305 created, plus its creation time. */
306 static ULONGLONG
307 w32_get_timer_time (HANDLE thread)
309 ULONGLONG retval;
310 int use_system_time = 1;
311 /* The functions below return times in 100-ns units. */
312 const int tscale = 10 * TIMER_TICKS_PER_SEC;
314 if (thread && thread != INVALID_HANDLE_VALUE
315 && s_pfn_Get_Thread_Times != NULL)
317 FILETIME creation_ftime, exit_ftime, kernel_ftime, user_ftime;
318 ULARGE_INTEGER temp_creation, temp_kernel, temp_user;
320 if (s_pfn_Get_Thread_Times (thread, &creation_ftime, &exit_ftime,
321 &kernel_ftime, &user_ftime))
323 use_system_time = 0;
324 temp_creation.LowPart = creation_ftime.dwLowDateTime;
325 temp_creation.HighPart = creation_ftime.dwHighDateTime;
326 temp_kernel.LowPart = kernel_ftime.dwLowDateTime;
327 temp_kernel.HighPart = kernel_ftime.dwHighDateTime;
328 temp_user.LowPart = user_ftime.dwLowDateTime;
329 temp_user.HighPart = user_ftime.dwHighDateTime;
330 retval =
331 temp_creation.QuadPart / tscale + temp_kernel.QuadPart / tscale
332 + temp_user.QuadPart / tscale;
334 else
335 DebPrint (("GetThreadTimes failed with error code %lu\n",
336 GetLastError ()));
339 if (use_system_time)
341 FILETIME current_ftime;
342 ULARGE_INTEGER temp;
344 GetSystemTimeAsFileTime (&current_ftime);
346 temp.LowPart = current_ftime.dwLowDateTime;
347 temp.HighPart = current_ftime.dwHighDateTime;
349 retval = temp.QuadPart / tscale;
352 return retval;
355 /* Thread function for a timer thread. */
356 static DWORD WINAPI
357 timer_loop (LPVOID arg)
359 struct itimer_data *itimer = (struct itimer_data *)arg;
360 int which = itimer->type;
361 int sig = (which == ITIMER_REAL) ? SIGALRM : SIGPROF;
362 CRITICAL_SECTION *crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
363 const DWORD max_sleep = MAX_SINGLE_SLEEP * 1000 / TIMER_TICKS_PER_SEC;
364 HANDLE hth = (which == ITIMER_REAL) ? NULL : itimer->caller_thread;
366 while (1)
368 DWORD sleep_time;
369 signal_handler handler;
370 ULONGLONG now, expire, reload;
372 /* Load new values if requested by setitimer. */
373 EnterCriticalSection (crit);
374 expire = itimer->expire;
375 reload = itimer->reload;
376 LeaveCriticalSection (crit);
377 if (itimer->terminate)
378 return 0;
380 if (expire == 0)
382 /* We are idle. */
383 Sleep (max_sleep);
384 continue;
387 if (expire > (now = w32_get_timer_time (hth)))
388 sleep_time = expire - now;
389 else
390 sleep_time = 0;
391 /* Don't sleep too long at a time, to be able to see the
392 termination flag without too long a delay. */
393 while (sleep_time > max_sleep)
395 if (itimer->terminate)
396 return 0;
397 Sleep (max_sleep);
398 EnterCriticalSection (crit);
399 expire = itimer->expire;
400 LeaveCriticalSection (crit);
401 sleep_time =
402 (expire > (now = w32_get_timer_time (hth))) ? expire - now : 0;
404 if (itimer->terminate)
405 return 0;
406 if (sleep_time > 0)
408 Sleep (sleep_time * 1000 / TIMER_TICKS_PER_SEC);
409 /* Always sleep past the expiration time, to make sure we
410 never call the handler _before_ the expiration time,
411 always slightly after it. Sleep(5) makes sure we don't
412 hog the CPU by calling 'w32_get_timer_time' with high
413 frequency, and also let other threads work. */
414 while (w32_get_timer_time (hth) < expire)
415 Sleep (5);
418 EnterCriticalSection (crit);
419 expire = itimer->expire;
420 LeaveCriticalSection (crit);
421 if (expire == 0)
422 continue;
424 /* Time's up. */
425 handler = sig_handlers[sig];
426 if (!(handler == SIG_DFL || handler == SIG_IGN || handler == SIG_ERR)
427 /* FIXME: Don't ignore masked signals. Instead, record that
428 they happened and reissue them when the signal is
429 unblocked. */
430 && !sigismember (&sig_mask, sig)
431 /* Simulate masking of SIGALRM and SIGPROF when processing
432 fatal signals. */
433 && !fatal_error_in_progress
434 && itimer->caller_thread)
436 /* Simulate a signal delivered to the thread which installed
437 the timer, by suspending that thread while the handler
438 runs. */
439 HANDLE th = itimer->caller_thread;
440 DWORD result = SuspendThread (th);
442 if (result == (DWORD)-1)
443 return 2;
445 handler (sig);
446 ResumeThread (th);
449 /* Update expiration time and loop. */
450 EnterCriticalSection (crit);
451 expire = itimer->expire;
452 if (expire == 0)
454 LeaveCriticalSection (crit);
455 continue;
457 reload = itimer->reload;
458 if (reload > 0)
460 now = w32_get_timer_time (hth);
461 if (expire <= now)
463 ULONGLONG lag = now - expire;
465 /* If we missed some opportunities (presumably while
466 sleeping or while the signal handler ran), skip
467 them. */
468 if (lag > reload)
469 expire = now - (lag % reload);
471 expire += reload;
474 else
475 expire = 0; /* become idle */
476 itimer->expire = expire;
477 LeaveCriticalSection (crit);
479 return 0;
482 static void
483 stop_timer_thread (int which)
485 struct itimer_data *itimer =
486 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
487 int i;
488 DWORD err, exit_code = 255;
489 BOOL status;
491 /* Signal the thread that it should terminate. */
492 itimer->terminate = 1;
494 if (itimer->timer_thread == NULL)
495 return;
497 /* Wait for the timer thread to terminate voluntarily, then kill it
498 if it doesn't. This loop waits twice more than the maximum
499 amount of time a timer thread sleeps, see above. */
500 for (i = 0; i < MAX_SINGLE_SLEEP / 5; i++)
502 if (!((status = GetExitCodeThread (itimer->timer_thread, &exit_code))
503 && exit_code == STILL_ACTIVE))
504 break;
505 Sleep (10);
507 if ((status == FALSE && (err = GetLastError ()) == ERROR_INVALID_HANDLE)
508 || exit_code == STILL_ACTIVE)
510 if (!(status == FALSE && err == ERROR_INVALID_HANDLE))
511 TerminateThread (itimer->timer_thread, 0);
514 /* Clean up. */
515 CloseHandle (itimer->timer_thread);
516 itimer->timer_thread = NULL;
517 if (itimer->caller_thread)
519 CloseHandle (itimer->caller_thread);
520 itimer->caller_thread = NULL;
524 /* This is called at shutdown time from term_ntproc. */
525 void
526 term_timers (void)
528 if (real_itimer.timer_thread)
529 stop_timer_thread (ITIMER_REAL);
530 if (prof_itimer.timer_thread)
531 stop_timer_thread (ITIMER_PROF);
533 /* We are going to delete the critical sections, so timers cannot
534 work after this. */
535 disable_itimers = 1;
537 DeleteCriticalSection (&crit_real);
538 DeleteCriticalSection (&crit_prof);
539 DeleteCriticalSection (&crit_sig);
542 /* This is called at initialization time from init_ntproc. */
543 void
544 init_timers (void)
546 /* GetThreadTimes is not available on all versions of Windows, so
547 need to probe for its availability dynamically, and call it
548 through a pointer. */
549 s_pfn_Get_Thread_Times = NULL; /* in case dumped Emacs comes with a value */
550 if (os_subtype != OS_9X)
551 s_pfn_Get_Thread_Times =
552 (GetThreadTimes_Proc)GetProcAddress (GetModuleHandle ("kernel32.dll"),
553 "GetThreadTimes");
555 /* Make sure we start with zeroed out itimer structures, since
556 dumping may have left there traces of threads long dead. */
557 memset (&real_itimer, 0, sizeof real_itimer);
558 memset (&prof_itimer, 0, sizeof prof_itimer);
560 InitializeCriticalSection (&crit_real);
561 InitializeCriticalSection (&crit_prof);
562 InitializeCriticalSection (&crit_sig);
564 disable_itimers = 0;
567 static int
568 start_timer_thread (int which)
570 DWORD exit_code, tid;
571 HANDLE th;
572 struct itimer_data *itimer =
573 (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
575 if (itimer->timer_thread
576 && GetExitCodeThread (itimer->timer_thread, &exit_code)
577 && exit_code == STILL_ACTIVE)
578 return 0;
580 /* Clean up after possibly exited thread. */
581 if (itimer->timer_thread)
583 CloseHandle (itimer->timer_thread);
584 itimer->timer_thread = NULL;
586 if (itimer->caller_thread)
588 CloseHandle (itimer->caller_thread);
589 itimer->caller_thread = NULL;
592 /* Start a new thread. */
593 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
594 GetCurrentProcess (), &th, 0, FALSE,
595 DUPLICATE_SAME_ACCESS))
597 errno = ESRCH;
598 return -1;
600 itimer->terminate = 0;
601 itimer->type = which;
602 itimer->caller_thread = th;
603 /* Request that no more than 64KB of stack be reserved for this
604 thread, to avoid reserving too much memory, which would get in
605 the way of threads we start to wait for subprocesses. See also
606 new_child below. */
607 itimer->timer_thread = CreateThread (NULL, 64 * 1024, timer_loop,
608 (void *)itimer, 0x00010000, &tid);
610 if (!itimer->timer_thread)
612 CloseHandle (itimer->caller_thread);
613 itimer->caller_thread = NULL;
614 errno = EAGAIN;
615 return -1;
618 /* This is needed to make sure that the timer thread running for
619 profiling gets CPU as soon as the Sleep call terminates. */
620 if (which == ITIMER_PROF)
621 SetThreadPriority (itimer->timer_thread, THREAD_PRIORITY_TIME_CRITICAL);
623 return 0;
626 /* Most of the code of getitimer and setitimer (but not of their
627 subroutines) was shamelessly stolen from itimer.c in the DJGPP
628 library, see www.delorie.com/djgpp. */
630 getitimer (int which, struct itimerval *value)
632 volatile ULONGLONG *t_expire;
633 volatile ULONGLONG *t_reload;
634 ULONGLONG expire, reload;
635 __int64 usecs;
636 CRITICAL_SECTION *crit;
637 struct itimer_data *itimer;
639 if (disable_itimers)
640 return -1;
642 if (!value)
644 errno = EFAULT;
645 return -1;
648 if (which != ITIMER_REAL && which != ITIMER_PROF)
650 errno = EINVAL;
651 return -1;
654 itimer = (which == ITIMER_REAL) ? &real_itimer : &prof_itimer;
656 ticks_now = w32_get_timer_time ((which == ITIMER_REAL)
657 ? NULL
658 : GetCurrentThread ());
660 t_expire = &itimer->expire;
661 t_reload = &itimer->reload;
662 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
664 EnterCriticalSection (crit);
665 reload = *t_reload;
666 expire = *t_expire;
667 LeaveCriticalSection (crit);
669 if (expire)
670 expire -= ticks_now;
672 value->it_value.tv_sec = expire / TIMER_TICKS_PER_SEC;
673 usecs =
674 (expire % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
675 value->it_value.tv_usec = usecs;
676 value->it_interval.tv_sec = reload / TIMER_TICKS_PER_SEC;
677 usecs =
678 (reload % TIMER_TICKS_PER_SEC) * (__int64)1000000 / TIMER_TICKS_PER_SEC;
679 value->it_interval.tv_usec= usecs;
681 return 0;
685 setitimer(int which, struct itimerval *value, struct itimerval *ovalue)
687 volatile ULONGLONG *t_expire, *t_reload;
688 ULONGLONG expire, reload, expire_old, reload_old;
689 __int64 usecs;
690 CRITICAL_SECTION *crit;
691 struct itimerval tem, *ptem;
693 if (disable_itimers)
694 return -1;
696 /* Posix systems expect timer values smaller than the resolution of
697 the system clock be rounded up to the clock resolution. First
698 time we are called, measure the clock tick resolution. */
699 if (!clocks_min)
701 ULONGLONG t1, t2;
703 for (t1 = w32_get_timer_time (NULL);
704 (t2 = w32_get_timer_time (NULL)) == t1; )
706 clocks_min = t2 - t1;
709 if (ovalue)
710 ptem = ovalue;
711 else
712 ptem = &tem;
714 if (getitimer (which, ptem)) /* also sets ticks_now */
715 return -1; /* errno already set */
717 t_expire =
718 (which == ITIMER_REAL) ? &real_itimer.expire : &prof_itimer.expire;
719 t_reload =
720 (which == ITIMER_REAL) ? &real_itimer.reload : &prof_itimer.reload;
722 crit = (which == ITIMER_REAL) ? &crit_real : &crit_prof;
724 if (!value
725 || (value->it_value.tv_sec == 0 && value->it_value.tv_usec == 0))
727 EnterCriticalSection (crit);
728 /* Disable the timer. */
729 *t_expire = 0;
730 *t_reload = 0;
731 LeaveCriticalSection (crit);
732 return 0;
735 reload = value->it_interval.tv_sec * TIMER_TICKS_PER_SEC;
737 usecs = value->it_interval.tv_usec;
738 if (value->it_interval.tv_sec == 0
739 && usecs && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
740 reload = clocks_min;
741 else
743 usecs *= TIMER_TICKS_PER_SEC;
744 reload += usecs / 1000000;
747 expire = value->it_value.tv_sec * TIMER_TICKS_PER_SEC;
748 usecs = value->it_value.tv_usec;
749 if (value->it_value.tv_sec == 0
750 && usecs * TIMER_TICKS_PER_SEC < clocks_min * 1000000)
751 expire = clocks_min;
752 else
754 usecs *= TIMER_TICKS_PER_SEC;
755 expire += usecs / 1000000;
758 expire += ticks_now;
760 EnterCriticalSection (crit);
761 expire_old = *t_expire;
762 reload_old = *t_reload;
763 if (!(expire == expire_old && reload == reload_old))
765 *t_reload = reload;
766 *t_expire = expire;
768 LeaveCriticalSection (crit);
770 return start_timer_thread (which);
774 alarm (int seconds)
776 #ifdef HAVE_SETITIMER
777 struct itimerval new_values, old_values;
779 new_values.it_value.tv_sec = seconds;
780 new_values.it_value.tv_usec = 0;
781 new_values.it_interval.tv_sec = new_values.it_interval.tv_usec = 0;
783 if (setitimer (ITIMER_REAL, &new_values, &old_values) < 0)
784 return 0;
785 return old_values.it_value.tv_sec;
786 #else
787 return seconds;
788 #endif
791 /* Defined in <process.h> which conflicts with the local copy */
792 #define _P_NOWAIT 1
794 /* Child process management list. */
795 int child_proc_count = 0;
796 child_process child_procs[ MAX_CHILDREN ];
798 static DWORD WINAPI reader_thread (void *arg);
800 /* Find an unused process slot. */
801 child_process *
802 new_child (void)
804 child_process *cp;
805 DWORD id;
807 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
808 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
809 goto Initialize;
810 if (child_proc_count == MAX_CHILDREN)
812 int i = 0;
813 child_process *dead_cp = NULL;
815 DebPrint (("new_child: No vacant slots, looking for dead processes\n"));
816 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
817 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
819 DWORD status = 0;
821 if (!GetExitCodeProcess (cp->procinfo.hProcess, &status))
823 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
824 GetLastError (), cp->procinfo.dwProcessId));
825 status = STILL_ACTIVE;
827 if (status != STILL_ACTIVE
828 || WaitForSingleObject (cp->procinfo.hProcess, 0) == WAIT_OBJECT_0)
830 DebPrint (("new_child: Freeing slot of dead process %d, fd %d\n",
831 cp->procinfo.dwProcessId, cp->fd));
832 CloseHandle (cp->procinfo.hProcess);
833 cp->procinfo.hProcess = NULL;
834 CloseHandle (cp->procinfo.hThread);
835 cp->procinfo.hThread = NULL;
836 /* Free up to 2 dead slots at a time, so that if we
837 have a lot of them, they will eventually all be
838 freed when the tornado ends. */
839 if (i == 0)
840 dead_cp = cp;
841 else
842 break;
843 i++;
846 if (dead_cp)
848 cp = dead_cp;
849 goto Initialize;
852 if (child_proc_count == MAX_CHILDREN)
853 return NULL;
854 cp = &child_procs[child_proc_count++];
856 Initialize:
857 /* Last opportunity to avoid leaking handles before we forget them
858 for good. */
859 if (cp->procinfo.hProcess)
860 CloseHandle (cp->procinfo.hProcess);
861 if (cp->procinfo.hThread)
862 CloseHandle (cp->procinfo.hThread);
863 memset (cp, 0, sizeof (*cp));
864 cp->fd = -1;
865 cp->pid = -1;
866 cp->procinfo.hProcess = NULL;
867 cp->status = STATUS_READ_ERROR;
869 /* use manual reset event so that select() will function properly */
870 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
871 if (cp->char_avail)
873 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
874 if (cp->char_consumed)
876 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
877 It means that the 64K stack we are requesting in the 2nd
878 argument is how much memory should be reserved for the
879 stack. If we don't use this flag, the memory requested
880 by the 2nd argument is the amount actually _committed_,
881 but Windows reserves 8MB of memory for each thread's
882 stack. (The 8MB figure comes from the -stack
883 command-line argument we pass to the linker when building
884 Emacs, but that's because we need a large stack for
885 Emacs's main thread.) Since we request 2GB of reserved
886 memory at startup (see w32heap.c), which is close to the
887 maximum memory available for a 32-bit process on Windows,
888 the 8MB reservation for each thread causes failures in
889 starting subprocesses, because we create a thread running
890 reader_thread for each subprocess. As 8MB of stack is
891 way too much for reader_thread, forcing Windows to
892 reserve less wins the day. */
893 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
894 0x00010000, &id);
895 if (cp->thrd)
896 return cp;
899 delete_child (cp);
900 return NULL;
903 void
904 delete_child (child_process *cp)
906 int i;
908 /* Should not be deleting a child that is still needed. */
909 for (i = 0; i < MAXDESC; i++)
910 if (fd_info[i].cp == cp)
911 emacs_abort ();
913 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
914 return;
916 /* reap thread if necessary */
917 if (cp->thrd)
919 DWORD rc;
921 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
923 /* let the thread exit cleanly if possible */
924 cp->status = STATUS_READ_ERROR;
925 SetEvent (cp->char_consumed);
926 #if 0
927 /* We used to forcibly terminate the thread here, but it
928 is normally unnecessary, and in abnormal cases, the worst that
929 will happen is we have an extra idle thread hanging around
930 waiting for the zombie process. */
931 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
933 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
934 "with %lu for fd %ld\n", GetLastError (), cp->fd));
935 TerminateThread (cp->thrd, 0);
937 #endif
939 CloseHandle (cp->thrd);
940 cp->thrd = NULL;
942 if (cp->char_avail)
944 CloseHandle (cp->char_avail);
945 cp->char_avail = NULL;
947 if (cp->char_consumed)
949 CloseHandle (cp->char_consumed);
950 cp->char_consumed = NULL;
953 /* update child_proc_count (highest numbered slot in use plus one) */
954 if (cp == child_procs + child_proc_count - 1)
956 for (i = child_proc_count-1; i >= 0; i--)
957 if (CHILD_ACTIVE (&child_procs[i])
958 || child_procs[i].procinfo.hProcess != NULL)
960 child_proc_count = i + 1;
961 break;
964 if (i < 0)
965 child_proc_count = 0;
968 /* Find a child by pid. */
969 static child_process *
970 find_child_pid (DWORD pid)
972 child_process *cp;
974 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
975 if ((CHILD_ACTIVE (cp) || cp->procinfo.hProcess != NULL)
976 && pid == cp->pid)
977 return cp;
978 return NULL;
981 void
982 release_listen_threads (void)
984 int i;
986 for (i = child_proc_count - 1; i >= 0; i--)
988 if (CHILD_ACTIVE (&child_procs[i])
989 && (fd_info[child_procs[i].fd].flags & FILE_LISTEN))
990 child_procs[i].status = STATUS_READ_ERROR;
994 /* Thread proc for child process and socket reader threads. Each thread
995 is normally blocked until woken by select() to check for input by
996 reading one char. When the read completes, char_avail is signaled
997 to wake up the select emulator and the thread blocks itself again. */
998 static DWORD WINAPI
999 reader_thread (void *arg)
1001 child_process *cp;
1003 /* Our identity */
1004 cp = (child_process *)arg;
1006 /* We have to wait for the go-ahead before we can start */
1007 if (cp == NULL
1008 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
1009 || cp->fd < 0)
1010 return 1;
1012 for (;;)
1014 int rc;
1016 if (cp->fd >= 0 && fd_info[cp->fd].flags & FILE_LISTEN)
1017 rc = _sys_wait_accept (cp->fd);
1018 else
1019 rc = _sys_read_ahead (cp->fd);
1021 /* Don't bother waiting for the event if we already have been
1022 told to exit by delete_child. */
1023 if (cp->status == STATUS_READ_ERROR || !cp->char_avail)
1024 break;
1026 /* The name char_avail is a misnomer - it really just means the
1027 read-ahead has completed, whether successfully or not. */
1028 if (!SetEvent (cp->char_avail))
1030 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1031 (DWORD_PTR)cp->char_avail, GetLastError (),
1032 cp->fd, cp->pid));
1033 return 1;
1036 if (rc == STATUS_READ_ERROR)
1037 return 1;
1039 /* If the read died, the child has died so let the thread die */
1040 if (rc == STATUS_READ_FAILED)
1041 break;
1043 /* Don't bother waiting for the acknowledge if we already have
1044 been told to exit by delete_child. */
1045 if (cp->status == STATUS_READ_ERROR || !cp->char_consumed)
1046 break;
1048 /* Wait until our input is acknowledged before reading again */
1049 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
1051 DebPrint (("reader_thread.WaitForSingleObject failed with "
1052 "%lu for fd %ld\n", GetLastError (), cp->fd));
1053 break;
1055 /* delete_child sets status to STATUS_READ_ERROR when it wants
1056 us to exit. */
1057 if (cp->status == STATUS_READ_ERROR)
1058 break;
1060 return 0;
1063 /* To avoid Emacs changing directory, we just record here the
1064 directory the new process should start in. This is set just before
1065 calling sys_spawnve, and is not generally valid at any other time.
1066 Note that this directory's name is UTF-8 encoded. */
1067 static char * process_dir;
1069 static BOOL
1070 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
1071 pid_t * pPid, child_process *cp)
1073 STARTUPINFO start;
1074 SECURITY_ATTRIBUTES sec_attrs;
1075 #if 0
1076 SECURITY_DESCRIPTOR sec_desc;
1077 #endif
1078 DWORD flags;
1079 char dir[ MAX_PATH ];
1080 char *p;
1081 const char *ext;
1083 if (cp == NULL) emacs_abort ();
1085 memset (&start, 0, sizeof (start));
1086 start.cb = sizeof (start);
1088 #ifdef HAVE_NTGUI
1089 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1090 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1091 else
1092 start.dwFlags = STARTF_USESTDHANDLES;
1093 start.wShowWindow = SW_HIDE;
1095 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1096 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1097 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1098 #endif /* HAVE_NTGUI */
1100 #if 0
1101 /* Explicitly specify no security */
1102 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1103 goto EH_Fail;
1104 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1105 goto EH_Fail;
1106 #endif
1107 sec_attrs.nLength = sizeof (sec_attrs);
1108 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1109 sec_attrs.bInheritHandle = FALSE;
1111 filename_to_ansi (process_dir, dir);
1112 /* Can't use unixtodos_filename here, since that needs its file name
1113 argument encoded in UTF-8. OTOH, process_dir, which _is_ in
1114 UTF-8, points, to the directory computed by our caller, and we
1115 don't want to modify that, either. */
1116 for (p = dir; *p; p = CharNextA (p))
1117 if (*p == '/')
1118 *p = '\\';
1120 /* CreateProcess handles batch files as exe specially. This special
1121 handling fails when both the batch file and arguments are quoted.
1122 We pass NULL as exe to avoid the special handling. */
1123 if (exe && cmdline[0] == '"' &&
1124 (ext = strrchr (exe, '.')) &&
1125 (xstrcasecmp (ext, ".bat") == 0
1126 || xstrcasecmp (ext, ".cmd") == 0))
1127 exe = NULL;
1129 flags = (!NILP (Vw32_start_process_share_console)
1130 ? CREATE_NEW_PROCESS_GROUP
1131 : CREATE_NEW_CONSOLE);
1132 if (NILP (Vw32_start_process_inherit_error_mode))
1133 flags |= CREATE_DEFAULT_ERROR_MODE;
1134 if (!CreateProcessA (exe, cmdline, &sec_attrs, NULL, TRUE,
1135 flags, env, dir, &start, &cp->procinfo))
1136 goto EH_Fail;
1138 cp->pid = (int) cp->procinfo.dwProcessId;
1140 /* Hack for Windows 95, which assigns large (ie negative) pids */
1141 if (cp->pid < 0)
1142 cp->pid = -cp->pid;
1144 *pPid = cp->pid;
1146 return TRUE;
1148 EH_Fail:
1149 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1150 return FALSE;
1153 /* create_child doesn't know what emacs's file handle will be for waiting
1154 on output from the child, so we need to make this additional call
1155 to register the handle with the process
1156 This way the select emulator knows how to match file handles with
1157 entries in child_procs. */
1158 void
1159 register_child (pid_t pid, int fd)
1161 child_process *cp;
1163 cp = find_child_pid ((DWORD)pid);
1164 if (cp == NULL)
1166 DebPrint (("register_child unable to find pid %lu\n", pid));
1167 return;
1170 #ifdef FULL_DEBUG
1171 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1172 #endif
1174 cp->fd = fd;
1176 /* thread is initially blocked until select is called; set status so
1177 that select will release thread */
1178 cp->status = STATUS_READ_ACKNOWLEDGED;
1180 /* attach child_process to fd_info */
1181 if (fd_info[fd].cp != NULL)
1183 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1184 emacs_abort ();
1187 fd_info[fd].cp = cp;
1190 /* Called from waitpid when a process exits. */
1191 static void
1192 reap_subprocess (child_process *cp)
1194 if (cp->procinfo.hProcess)
1196 /* Reap the process */
1197 #ifdef FULL_DEBUG
1198 /* Process should have already died before we are called. */
1199 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1200 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp->fd));
1201 #endif
1202 CloseHandle (cp->procinfo.hProcess);
1203 cp->procinfo.hProcess = NULL;
1204 CloseHandle (cp->procinfo.hThread);
1205 cp->procinfo.hThread = NULL;
1208 /* If cp->fd was not closed yet, we might be still reading the
1209 process output, so don't free its resources just yet. The call
1210 to delete_child on behalf of this subprocess will be made by
1211 sys_read when the subprocess output is fully read. */
1212 if (cp->fd < 0)
1213 delete_child (cp);
1216 /* Wait for a child process specified by PID, or for any of our
1217 existing child processes (if PID is nonpositive) to die. When it
1218 does, close its handle. Return the pid of the process that died
1219 and fill in STATUS if non-NULL. */
1221 pid_t
1222 waitpid (pid_t pid, int *status, int options)
1224 DWORD active, retval;
1225 int nh;
1226 child_process *cp, *cps[MAX_CHILDREN];
1227 HANDLE wait_hnd[MAX_CHILDREN];
1228 DWORD timeout_ms;
1229 int dont_wait = (options & WNOHANG) != 0;
1231 nh = 0;
1232 /* According to Posix:
1234 PID = -1 means status is requested for any child process.
1236 PID > 0 means status is requested for a single child process
1237 whose pid is PID.
1239 PID = 0 means status is requested for any child process whose
1240 process group ID is equal to that of the calling process. But
1241 since Windows has only a limited support for process groups (only
1242 for console processes and only for the purposes of passing
1243 Ctrl-BREAK signal to them), and since we have no documented way
1244 of determining whether a given process belongs to our group, we
1245 treat 0 as -1.
1247 PID < -1 means status is requested for any child process whose
1248 process group ID is equal to the absolute value of PID. Again,
1249 since we don't support process groups, we treat that as -1. */
1250 if (pid > 0)
1252 int our_child = 0;
1254 /* We are requested to wait for a specific child. */
1255 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1257 /* Some child_procs might be sockets; ignore them. Also
1258 ignore subprocesses whose output is not yet completely
1259 read. */
1260 if (CHILD_ACTIVE (cp)
1261 && cp->procinfo.hProcess
1262 && cp->pid == pid)
1264 our_child = 1;
1265 break;
1268 if (our_child)
1270 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1272 wait_hnd[nh] = cp->procinfo.hProcess;
1273 cps[nh] = cp;
1274 nh++;
1276 else if (dont_wait)
1278 /* PID specifies our subprocess, but its status is not
1279 yet available. */
1280 return 0;
1283 if (nh == 0)
1285 /* No such child process, or nothing to wait for, so fail. */
1286 errno = ECHILD;
1287 return -1;
1290 else
1292 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1294 if (CHILD_ACTIVE (cp)
1295 && cp->procinfo.hProcess
1296 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1298 wait_hnd[nh] = cp->procinfo.hProcess;
1299 cps[nh] = cp;
1300 nh++;
1303 if (nh == 0)
1305 /* Nothing to wait on, so fail. */
1306 errno = ECHILD;
1307 return -1;
1311 if (dont_wait)
1312 timeout_ms = 0;
1313 else
1314 timeout_ms = 1000; /* check for quit about once a second. */
1318 QUIT;
1319 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1320 } while (active == WAIT_TIMEOUT && !dont_wait);
1322 if (active == WAIT_FAILED)
1324 errno = EBADF;
1325 return -1;
1327 else if (active == WAIT_TIMEOUT && dont_wait)
1329 /* PID specifies our subprocess, but it didn't exit yet, so its
1330 status is not yet available. */
1331 #ifdef FULL_DEBUG
1332 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1333 #endif
1334 return 0;
1336 else if (active >= WAIT_OBJECT_0
1337 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1339 active -= WAIT_OBJECT_0;
1341 else if (active >= WAIT_ABANDONED_0
1342 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1344 active -= WAIT_ABANDONED_0;
1346 else
1347 emacs_abort ();
1349 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1351 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1352 GetLastError ()));
1353 retval = 1;
1355 if (retval == STILL_ACTIVE)
1357 /* Should never happen. */
1358 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1359 if (pid > 0 && dont_wait)
1360 return 0;
1361 errno = EINVAL;
1362 return -1;
1365 /* Massage the exit code from the process to match the format expected
1366 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1367 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1369 if (retval == STATUS_CONTROL_C_EXIT)
1370 retval = SIGINT;
1371 else
1372 retval <<= 8;
1374 if (pid > 0 && active != 0)
1375 emacs_abort ();
1376 cp = cps[active];
1377 pid = cp->pid;
1378 #ifdef FULL_DEBUG
1379 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1380 #endif
1382 if (status)
1383 *status = retval;
1384 reap_subprocess (cp);
1386 return pid;
1389 /* Old versions of w32api headers don't have separate 32-bit and
1390 64-bit defines, but the one they have matches the 32-bit variety. */
1391 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1392 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1393 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1394 #endif
1396 /* Implementation note: This function works with file names encoded in
1397 the current ANSI codepage. */
1398 static void
1399 w32_executable_type (char * filename,
1400 int * is_dos_app,
1401 int * is_cygnus_app,
1402 int * is_gui_app)
1404 file_data executable;
1405 char * p;
1407 /* Default values in case we can't tell for sure. */
1408 *is_dos_app = FALSE;
1409 *is_cygnus_app = FALSE;
1410 *is_gui_app = FALSE;
1412 if (!open_input_file (&executable, filename))
1413 return;
1415 p = strrchr (filename, '.');
1417 /* We can only identify DOS .com programs from the extension. */
1418 if (p && xstrcasecmp (p, ".com") == 0)
1419 *is_dos_app = TRUE;
1420 else if (p && (xstrcasecmp (p, ".bat") == 0
1421 || xstrcasecmp (p, ".cmd") == 0))
1423 /* A DOS shell script - it appears that CreateProcess is happy to
1424 accept this (somewhat surprisingly); presumably it looks at
1425 COMSPEC to determine what executable to actually invoke.
1426 Therefore, we have to do the same here as well. */
1427 /* Actually, I think it uses the program association for that
1428 extension, which is defined in the registry. */
1429 p = egetenv ("COMSPEC");
1430 if (p)
1431 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1433 else
1435 /* Look for DOS .exe signature - if found, we must also check that
1436 it isn't really a 16- or 32-bit Windows exe, since both formats
1437 start with a DOS program stub. Note that 16-bit Windows
1438 executables use the OS/2 1.x format. */
1440 IMAGE_DOS_HEADER * dos_header;
1441 IMAGE_NT_HEADERS * nt_header;
1443 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1444 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1445 goto unwind;
1447 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1449 if ((char *) nt_header > (char *) dos_header + executable.size)
1451 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1452 *is_dos_app = TRUE;
1454 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1455 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1457 *is_dos_app = TRUE;
1459 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1461 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1462 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1464 /* Ensure we are using the 32 bit structure. */
1465 IMAGE_OPTIONAL_HEADER32 *opt
1466 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1467 data_dir = opt->DataDirectory;
1468 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1470 /* MingW 3.12 has the required 64 bit structs, but in case older
1471 versions don't, only check 64 bit exes if we know how. */
1472 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1473 else if (nt_header->OptionalHeader.Magic
1474 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1476 IMAGE_OPTIONAL_HEADER64 *opt
1477 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1478 data_dir = opt->DataDirectory;
1479 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1481 #endif
1482 if (data_dir)
1484 /* Look for cygwin.dll in DLL import list. */
1485 IMAGE_DATA_DIRECTORY import_dir =
1486 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1487 IMAGE_IMPORT_DESCRIPTOR * imports;
1488 IMAGE_SECTION_HEADER * section;
1490 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1491 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1492 executable);
1494 for ( ; imports->Name; imports++)
1496 char * dllname = RVA_TO_PTR (imports->Name, section,
1497 executable);
1499 /* The exact name of the cygwin dll has changed with
1500 various releases, but hopefully this will be reasonably
1501 future proof. */
1502 if (strncmp (dllname, "cygwin", 6) == 0)
1504 *is_cygnus_app = TRUE;
1505 break;
1512 unwind:
1513 close_file_data (&executable);
1516 static int
1517 compare_env (const void *strp1, const void *strp2)
1519 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1521 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1523 /* Sort order in command.com/cmd.exe is based on uppercasing
1524 names, so do the same here. */
1525 if (toupper (*str1) > toupper (*str2))
1526 return 1;
1527 else if (toupper (*str1) < toupper (*str2))
1528 return -1;
1529 str1++, str2++;
1532 if (*str1 == '=' && *str2 == '=')
1533 return 0;
1534 else if (*str1 == '=')
1535 return -1;
1536 else
1537 return 1;
1540 static void
1541 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1543 char **optr, **nptr;
1544 int num;
1546 nptr = new_envp;
1547 optr = envp1;
1548 while (*optr)
1549 *nptr++ = *optr++;
1550 num = optr - envp1;
1552 optr = envp2;
1553 while (*optr)
1554 *nptr++ = *optr++;
1555 num += optr - envp2;
1557 qsort (new_envp, num, sizeof (char *), compare_env);
1559 *nptr = NULL;
1562 /* When a new child process is created we need to register it in our list,
1563 so intercept spawn requests. */
1565 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1567 Lisp_Object program, full;
1568 char *cmdline, *env, *parg, **targ;
1569 int arglen, numenv;
1570 pid_t pid;
1571 child_process *cp;
1572 int is_dos_app, is_cygnus_app, is_gui_app;
1573 int do_quoting = 0;
1574 /* We pass our process ID to our children by setting up an environment
1575 variable in their environment. */
1576 char ppid_env_var_buffer[64];
1577 char *extra_env[] = {ppid_env_var_buffer, NULL};
1578 /* These are the characters that cause an argument to need quoting.
1579 Arguments with whitespace characters need quoting to prevent the
1580 argument being split into two or more. Arguments with wildcards
1581 are also quoted, for consistency with posix platforms, where wildcards
1582 are not expanded if we run the program directly without a shell.
1583 Some extra whitespace characters need quoting in Cygwin programs,
1584 so this list is conditionally modified below. */
1585 char *sepchars = " \t*?";
1586 /* This is for native w32 apps; modified below for Cygwin apps. */
1587 char escape_char = '\\';
1588 char cmdname_a[MAX_PATH];
1590 /* We don't care about the other modes */
1591 if (mode != _P_NOWAIT)
1593 errno = EINVAL;
1594 return -1;
1597 /* Handle executable names without an executable suffix. The caller
1598 already searched exec-path and verified the file is executable,
1599 but start-process doesn't do that for file names that are already
1600 absolute. So we double-check this here, just in case. */
1601 if (faccessat (AT_FDCWD, cmdname, X_OK, AT_EACCESS) != 0)
1603 struct gcpro gcpro1;
1605 program = build_string (cmdname);
1606 full = Qnil;
1607 GCPRO1 (program);
1608 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK), 0);
1609 UNGCPRO;
1610 if (NILP (full))
1612 errno = EINVAL;
1613 return -1;
1615 program = ENCODE_FILE (full);
1616 cmdname = SDATA (program);
1618 else
1620 char *p = alloca (strlen (cmdname) + 1);
1622 /* Don't change the command name we were passed by our caller
1623 (unixtodos_filename below will destructively mirror forward
1624 slashes). */
1625 cmdname = strcpy (p, cmdname);
1628 /* make sure argv[0] and cmdname are both in DOS format */
1629 unixtodos_filename (cmdname);
1630 /* argv[0] was encoded by caller using ENCODE_FILE, so it is in
1631 UTF-8. All the other arguments are encoded by ENCODE_SYSTEM or
1632 some such, and are in some ANSI codepage. We need to have
1633 argv[0] encoded in ANSI codepage. */
1634 filename_to_ansi (cmdname, cmdname_a);
1635 /* We explicitly require that the command's file name be encodable
1636 in the current ANSI codepage, because we will be invoking it via
1637 the ANSI APIs. */
1638 if (_mbspbrk (cmdname_a, "?"))
1640 errno = ENOENT;
1641 return -1;
1643 /* From here on, CMDNAME is an ANSI-encoded string. */
1644 cmdname = cmdname_a;
1645 argv[0] = cmdname;
1647 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1648 executable that is implicitly linked to the Cygnus dll (implying it
1649 was compiled with the Cygnus GNU toolchain and hence relies on
1650 cygwin.dll to parse the command line - we use this to decide how to
1651 escape quote chars in command line args that must be quoted).
1653 Also determine whether it is a GUI app, so that we don't hide its
1654 initial window unless specifically requested. */
1655 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1657 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1658 application to start it by specifying the helper app as cmdname,
1659 while leaving the real app name as argv[0]. */
1660 if (is_dos_app)
1662 char *p;
1664 cmdname = alloca (MAX_PATH);
1665 if (egetenv ("CMDPROXY"))
1666 strcpy (cmdname, egetenv ("CMDPROXY"));
1667 else
1668 strcpy (lispstpcpy (cmdname, Vinvocation_directory), "cmdproxy.exe");
1670 /* Can't use unixtodos_filename here, since that needs its file
1671 name argument encoded in UTF-8. */
1672 for (p = cmdname; *p; p = CharNextA (p))
1673 if (*p == '/')
1674 *p = '\\';
1677 /* we have to do some conjuring here to put argv and envp into the
1678 form CreateProcess wants... argv needs to be a space separated/null
1679 terminated list of parameters, and envp is a null
1680 separated/double-null terminated list of parameters.
1682 Additionally, zero-length args and args containing whitespace or
1683 quote chars need to be wrapped in double quotes - for this to work,
1684 embedded quotes need to be escaped as well. The aim is to ensure
1685 the child process reconstructs the argv array we start with
1686 exactly, so we treat quotes at the beginning and end of arguments
1687 as embedded quotes.
1689 The w32 GNU-based library from Cygnus doubles quotes to escape
1690 them, while MSVC uses backslash for escaping. (Actually the MSVC
1691 startup code does attempt to recognize doubled quotes and accept
1692 them, but gets it wrong and ends up requiring three quotes to get a
1693 single embedded quote!) So by default we decide whether to use
1694 quote or backslash as the escape character based on whether the
1695 binary is apparently a Cygnus compiled app.
1697 Note that using backslash to escape embedded quotes requires
1698 additional special handling if an embedded quote is already
1699 preceded by backslash, or if an arg requiring quoting ends with
1700 backslash. In such cases, the run of escape characters needs to be
1701 doubled. For consistency, we apply this special handling as long
1702 as the escape character is not quote.
1704 Since we have no idea how large argv and envp are likely to be we
1705 figure out list lengths on the fly and allocate them. */
1707 if (!NILP (Vw32_quote_process_args))
1709 do_quoting = 1;
1710 /* Override escape char by binding w32-quote-process-args to
1711 desired character, or use t for auto-selection. */
1712 if (INTEGERP (Vw32_quote_process_args))
1713 escape_char = XINT (Vw32_quote_process_args);
1714 else
1715 escape_char = is_cygnus_app ? '"' : '\\';
1718 /* Cygwin apps needs quoting a bit more often. */
1719 if (escape_char == '"')
1720 sepchars = "\r\n\t\f '";
1722 /* do argv... */
1723 arglen = 0;
1724 targ = argv;
1725 while (*targ)
1727 char * p = *targ;
1728 int need_quotes = 0;
1729 int escape_char_run = 0;
1731 if (*p == 0)
1732 need_quotes = 1;
1733 for ( ; *p; p++)
1735 if (escape_char == '"' && *p == '\\')
1736 /* If it's a Cygwin app, \ needs to be escaped. */
1737 arglen++;
1738 else if (*p == '"')
1740 /* allow for embedded quotes to be escaped */
1741 arglen++;
1742 need_quotes = 1;
1743 /* handle the case where the embedded quote is already escaped */
1744 if (escape_char_run > 0)
1746 /* To preserve the arg exactly, we need to double the
1747 preceding escape characters (plus adding one to
1748 escape the quote character itself). */
1749 arglen += escape_char_run;
1752 else if (strchr (sepchars, *p) != NULL)
1754 need_quotes = 1;
1757 if (*p == escape_char && escape_char != '"')
1758 escape_char_run++;
1759 else
1760 escape_char_run = 0;
1762 if (need_quotes)
1764 arglen += 2;
1765 /* handle the case where the arg ends with an escape char - we
1766 must not let the enclosing quote be escaped. */
1767 if (escape_char_run > 0)
1768 arglen += escape_char_run;
1770 arglen += strlen (*targ++) + 1;
1772 cmdline = alloca (arglen);
1773 targ = argv;
1774 parg = cmdline;
1775 while (*targ)
1777 char * p = *targ;
1778 int need_quotes = 0;
1780 if (*p == 0)
1781 need_quotes = 1;
1783 if (do_quoting)
1785 for ( ; *p; p++)
1786 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1787 need_quotes = 1;
1789 if (need_quotes)
1791 int escape_char_run = 0;
1792 /* char * first; */
1793 /* char * last; */
1795 p = *targ;
1796 /* first = p; */
1797 /* last = p + strlen (p) - 1; */
1798 *parg++ = '"';
1799 #if 0
1800 /* This version does not escape quotes if they occur at the
1801 beginning or end of the arg - this could lead to incorrect
1802 behavior when the arg itself represents a command line
1803 containing quoted args. I believe this was originally done
1804 as a hack to make some things work, before
1805 `w32-quote-process-args' was added. */
1806 while (*p)
1808 if (*p == '"' && p > first && p < last)
1809 *parg++ = escape_char; /* escape embedded quotes */
1810 *parg++ = *p++;
1812 #else
1813 for ( ; *p; p++)
1815 if (*p == '"')
1817 /* double preceding escape chars if any */
1818 while (escape_char_run > 0)
1820 *parg++ = escape_char;
1821 escape_char_run--;
1823 /* escape all quote chars, even at beginning or end */
1824 *parg++ = escape_char;
1826 else if (escape_char == '"' && *p == '\\')
1827 *parg++ = '\\';
1828 *parg++ = *p;
1830 if (*p == escape_char && escape_char != '"')
1831 escape_char_run++;
1832 else
1833 escape_char_run = 0;
1835 /* double escape chars before enclosing quote */
1836 while (escape_char_run > 0)
1838 *parg++ = escape_char;
1839 escape_char_run--;
1841 #endif
1842 *parg++ = '"';
1844 else
1846 strcpy (parg, *targ);
1847 parg += strlen (*targ);
1849 *parg++ = ' ';
1850 targ++;
1852 *--parg = '\0';
1854 /* and envp... */
1855 arglen = 1;
1856 targ = envp;
1857 numenv = 1; /* for end null */
1858 while (*targ)
1860 arglen += strlen (*targ++) + 1;
1861 numenv++;
1863 /* extra env vars... */
1864 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1865 GetCurrentProcessId ());
1866 arglen += strlen (ppid_env_var_buffer) + 1;
1867 numenv++;
1869 /* merge env passed in and extra env into one, and sort it. */
1870 targ = (char **) alloca (numenv * sizeof (char *));
1871 merge_and_sort_env (envp, extra_env, targ);
1873 /* concatenate env entries. */
1874 env = alloca (arglen);
1875 parg = env;
1876 while (*targ)
1878 strcpy (parg, *targ);
1879 parg += strlen (*targ++);
1880 *parg++ = '\0';
1882 *parg++ = '\0';
1883 *parg = '\0';
1885 cp = new_child ();
1886 if (cp == NULL)
1888 errno = EAGAIN;
1889 return -1;
1892 /* Now create the process. */
1893 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1895 delete_child (cp);
1896 errno = ENOEXEC;
1897 return -1;
1900 return pid;
1903 /* Emulate the select call
1904 Wait for available input on any of the given rfds, or timeout if
1905 a timeout is given and no input is detected
1906 wfds and efds are not supported and must be NULL.
1908 For simplicity, we detect the death of child processes here and
1909 synchronously call the SIGCHLD handler. Since it is possible for
1910 children to be created without a corresponding pipe handle from which
1911 to read output, we wait separately on the process handles as well as
1912 the char_avail events for each process pipe. We only call
1913 wait/reap_process when the process actually terminates.
1915 To reduce the number of places in which Emacs can be hung such that
1916 C-g is not able to interrupt it, we always wait on interrupt_handle
1917 (which is signaled by the input thread when C-g is detected). If we
1918 detect that we were woken up by C-g, we return -1 with errno set to
1919 EINTR as on Unix. */
1921 /* From w32console.c */
1922 extern HANDLE keyboard_handle;
1924 /* From w32xfns.c */
1925 extern HANDLE interrupt_handle;
1927 /* From process.c */
1928 extern int proc_buffered_char[];
1931 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1932 struct timespec *timeout, void *ignored)
1934 SELECT_TYPE orfds;
1935 DWORD timeout_ms, start_time;
1936 int i, nh, nc, nr;
1937 DWORD active;
1938 child_process *cp, *cps[MAX_CHILDREN];
1939 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1940 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1942 timeout_ms =
1943 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1945 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1946 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1948 Sleep (timeout_ms);
1949 return 0;
1952 /* Otherwise, we only handle rfds, so fail otherwise. */
1953 if (rfds == NULL || wfds != NULL || efds != NULL)
1955 errno = EINVAL;
1956 return -1;
1959 orfds = *rfds;
1960 FD_ZERO (rfds);
1961 nr = 0;
1963 /* If interrupt_handle is available and valid, always wait on it, to
1964 detect C-g (quit). */
1965 nh = 0;
1966 if (interrupt_handle && interrupt_handle != INVALID_HANDLE_VALUE)
1968 wait_hnd[0] = interrupt_handle;
1969 fdindex[0] = -1;
1970 nh++;
1973 /* Build a list of pipe handles to wait on. */
1974 for (i = 0; i < nfds; i++)
1975 if (FD_ISSET (i, &orfds))
1977 if (i == 0)
1979 if (keyboard_handle)
1981 /* Handle stdin specially */
1982 wait_hnd[nh] = keyboard_handle;
1983 fdindex[nh] = i;
1984 nh++;
1987 /* Check for any emacs-generated input in the queue since
1988 it won't be detected in the wait */
1989 if (detect_input_pending ())
1991 FD_SET (i, rfds);
1992 return 1;
1994 else if (noninteractive)
1996 if (handle_file_notifications (NULL))
1997 return 1;
2000 else
2002 /* Child process and socket/comm port input. */
2003 cp = fd_info[i].cp;
2004 if (cp)
2006 int current_status = cp->status;
2008 if (current_status == STATUS_READ_ACKNOWLEDGED)
2010 /* Tell reader thread which file handle to use. */
2011 cp->fd = i;
2012 /* Wake up the reader thread for this process */
2013 cp->status = STATUS_READ_READY;
2014 if (!SetEvent (cp->char_consumed))
2015 DebPrint (("sys_select.SetEvent failed with "
2016 "%lu for fd %ld\n", GetLastError (), i));
2019 #ifdef CHECK_INTERLOCK
2020 /* slightly crude cross-checking of interlock between threads */
2022 current_status = cp->status;
2023 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
2025 /* char_avail has been signaled, so status (which may
2026 have changed) should indicate read has completed
2027 but has not been acknowledged. */
2028 current_status = cp->status;
2029 if (current_status != STATUS_READ_SUCCEEDED
2030 && current_status != STATUS_READ_FAILED)
2031 DebPrint (("char_avail set, but read not completed: status %d\n",
2032 current_status));
2034 else
2036 /* char_avail has not been signaled, so status should
2037 indicate that read is in progress; small possibility
2038 that read has completed but event wasn't yet signaled
2039 when we tested it (because a context switch occurred
2040 or if running on separate CPUs). */
2041 if (current_status != STATUS_READ_READY
2042 && current_status != STATUS_READ_IN_PROGRESS
2043 && current_status != STATUS_READ_SUCCEEDED
2044 && current_status != STATUS_READ_FAILED)
2045 DebPrint (("char_avail reset, but read status is bad: %d\n",
2046 current_status));
2048 #endif
2049 wait_hnd[nh] = cp->char_avail;
2050 fdindex[nh] = i;
2051 if (!wait_hnd[nh]) emacs_abort ();
2052 nh++;
2053 #ifdef FULL_DEBUG
2054 DebPrint (("select waiting on child %d fd %d\n",
2055 cp-child_procs, i));
2056 #endif
2058 else
2060 /* Unable to find something to wait on for this fd, skip */
2062 /* Note that this is not a fatal error, and can in fact
2063 happen in unusual circumstances. Specifically, if
2064 sys_spawnve fails, eg. because the program doesn't
2065 exist, and debug-on-error is t so Fsignal invokes a
2066 nested input loop, then the process output pipe is
2067 still included in input_wait_mask with no child_proc
2068 associated with it. (It is removed when the debugger
2069 exits the nested input loop and the error is thrown.) */
2071 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
2076 count_children:
2077 /* Add handles of child processes. */
2078 nc = 0;
2079 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
2080 /* Some child_procs might be sockets; ignore them. Also some
2081 children may have died already, but we haven't finished reading
2082 the process output; ignore them too. */
2083 if ((CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
2084 && (cp->fd < 0
2085 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
2086 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
2089 wait_hnd[nh + nc] = cp->procinfo.hProcess;
2090 cps[nc] = cp;
2091 nc++;
2094 /* Nothing to look for, so we didn't find anything */
2095 if (nh + nc == 0)
2097 if (timeout)
2098 Sleep (timeout_ms);
2099 if (noninteractive)
2101 if (handle_file_notifications (NULL))
2102 return 1;
2104 return 0;
2107 start_time = GetTickCount ();
2109 /* Wait for input or child death to be signaled. If user input is
2110 allowed, then also accept window messages. */
2111 if (FD_ISSET (0, &orfds))
2112 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
2113 QS_ALLINPUT);
2114 else
2115 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
2117 if (active == WAIT_FAILED)
2119 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2120 nh + nc, timeout_ms, GetLastError ()));
2121 /* don't return EBADF - this causes wait_reading_process_output to
2122 abort; WAIT_FAILED is returned when single-stepping under
2123 Windows 95 after switching thread focus in debugger, and
2124 possibly at other times. */
2125 errno = EINTR;
2126 return -1;
2128 else if (active == WAIT_TIMEOUT)
2130 if (noninteractive)
2132 if (handle_file_notifications (NULL))
2133 return 1;
2135 return 0;
2137 else if (active >= WAIT_OBJECT_0
2138 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
2140 active -= WAIT_OBJECT_0;
2142 else if (active >= WAIT_ABANDONED_0
2143 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
2145 active -= WAIT_ABANDONED_0;
2147 else
2148 emacs_abort ();
2150 /* Loop over all handles after active (now officially documented as
2151 being the first signaled handle in the array). We do this to
2152 ensure fairness, so that all channels with data available will be
2153 processed - otherwise higher numbered channels could be starved. */
2156 if (active == nh + nc)
2158 /* There are messages in the lisp thread's queue; we must
2159 drain the queue now to ensure they are processed promptly,
2160 because if we don't do so, we will not be woken again until
2161 further messages arrive.
2163 NB. If ever we allow window message procedures to callback
2164 into lisp, we will need to ensure messages are dispatched
2165 at a safe time for lisp code to be run (*), and we may also
2166 want to provide some hooks in the dispatch loop to cater
2167 for modeless dialogs created by lisp (ie. to register
2168 window handles to pass to IsDialogMessage).
2170 (*) Note that MsgWaitForMultipleObjects above is an
2171 internal dispatch point for messages that are sent to
2172 windows created by this thread. */
2173 if (drain_message_queue ()
2174 /* If drain_message_queue returns non-zero, that means
2175 we received a WM_EMACS_FILENOTIFY message. If this
2176 is a TTY frame, we must signal the caller that keyboard
2177 input is available, so that w32_console_read_socket
2178 will be called to pick up the notifications. If we
2179 don't do that, file notifications will only work when
2180 the Emacs TTY frame has focus. */
2181 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2182 /* they asked for stdin reads */
2183 && FD_ISSET (0, &orfds)
2184 /* the stdin handle is valid */
2185 && keyboard_handle)
2187 FD_SET (0, rfds);
2188 if (nr == 0)
2189 nr = 1;
2192 else if (active >= nh)
2194 cp = cps[active - nh];
2196 /* We cannot always signal SIGCHLD immediately; if we have not
2197 finished reading the process output, we must delay sending
2198 SIGCHLD until we do. */
2200 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2201 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2202 /* SIG_DFL for SIGCHLD is ignore */
2203 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2204 sig_handlers[SIGCHLD] != SIG_IGN)
2206 #ifdef FULL_DEBUG
2207 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2208 cp->pid));
2209 #endif
2210 sig_handlers[SIGCHLD] (SIGCHLD);
2213 else if (fdindex[active] == -1)
2215 /* Quit (C-g) was detected. */
2216 errno = EINTR;
2217 return -1;
2219 else if (fdindex[active] == 0)
2221 /* Keyboard input available */
2222 FD_SET (0, rfds);
2223 nr++;
2225 else
2227 /* must be a socket or pipe - read ahead should have
2228 completed, either succeeding or failing. */
2229 FD_SET (fdindex[active], rfds);
2230 nr++;
2233 /* Even though wait_reading_process_output only reads from at most
2234 one channel, we must process all channels here so that we reap
2235 all children that have died. */
2236 while (++active < nh + nc)
2237 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2238 break;
2239 } while (active < nh + nc);
2241 if (noninteractive)
2243 if (handle_file_notifications (NULL))
2244 nr++;
2247 /* If no input has arrived and timeout hasn't expired, wait again. */
2248 if (nr == 0)
2250 DWORD elapsed = GetTickCount () - start_time;
2252 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2254 if (timeout_ms != INFINITE)
2255 timeout_ms -= elapsed;
2256 goto count_children;
2260 return nr;
2263 /* Substitute for certain kill () operations */
2265 static BOOL CALLBACK
2266 find_child_console (HWND hwnd, LPARAM arg)
2268 child_process * cp = (child_process *) arg;
2269 DWORD process_id;
2271 GetWindowThreadProcessId (hwnd, &process_id);
2272 if (process_id == cp->procinfo.dwProcessId)
2274 char window_class[32];
2276 GetClassName (hwnd, window_class, sizeof (window_class));
2277 if (strcmp (window_class,
2278 (os_subtype == OS_9X)
2279 ? "tty"
2280 : "ConsoleWindowClass") == 0)
2282 cp->hwnd = hwnd;
2283 return FALSE;
2286 /* keep looking */
2287 return TRUE;
2290 /* Emulate 'kill', but only for other processes. */
2292 sys_kill (pid_t pid, int sig)
2294 child_process *cp;
2295 HANDLE proc_hand;
2296 int need_to_free = 0;
2297 int rc = 0;
2299 /* Each process is in its own process group. */
2300 if (pid < 0)
2301 pid = -pid;
2303 /* Only handle signals that will result in the process dying */
2304 if (sig != 0
2305 && sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2307 errno = EINVAL;
2308 return -1;
2311 if (sig == 0)
2313 /* It will take _some_ time before PID 4 or less on Windows will
2314 be Emacs... */
2315 if (pid <= 4)
2317 errno = EPERM;
2318 return -1;
2320 proc_hand = OpenProcess (PROCESS_QUERY_INFORMATION, 0, pid);
2321 if (proc_hand == NULL)
2323 DWORD err = GetLastError ();
2325 switch (err)
2327 case ERROR_ACCESS_DENIED: /* existing process, but access denied */
2328 errno = EPERM;
2329 return -1;
2330 case ERROR_INVALID_PARAMETER: /* process PID does not exist */
2331 errno = ESRCH;
2332 return -1;
2335 else
2336 CloseHandle (proc_hand);
2337 return 0;
2340 cp = find_child_pid (pid);
2341 if (cp == NULL)
2343 /* We were passed a PID of something other than our subprocess.
2344 If that is our own PID, we will send to ourself a message to
2345 close the selected frame, which does not necessarily
2346 terminates Emacs. But then we are not supposed to call
2347 sys_kill with our own PID. */
2348 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2349 if (proc_hand == NULL)
2351 errno = EPERM;
2352 return -1;
2354 need_to_free = 1;
2356 else
2358 proc_hand = cp->procinfo.hProcess;
2359 pid = cp->procinfo.dwProcessId;
2361 /* Try to locate console window for process. */
2362 EnumWindows (find_child_console, (LPARAM) cp);
2365 if (sig == SIGINT || sig == SIGQUIT)
2367 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2369 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2370 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2371 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2372 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2373 HWND foreground_window;
2375 if (break_scan_code == 0)
2377 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2378 vk_break_code = 'C';
2379 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2382 foreground_window = GetForegroundWindow ();
2383 if (foreground_window)
2385 /* NT 5.0, and apparently also Windows 98, will not allow
2386 a Window to be set to foreground directly without the
2387 user's involvement. The workaround is to attach
2388 ourselves to the thread that owns the foreground
2389 window, since that is the only thread that can set the
2390 foreground window. */
2391 DWORD foreground_thread, child_thread;
2392 foreground_thread =
2393 GetWindowThreadProcessId (foreground_window, NULL);
2394 if (foreground_thread == GetCurrentThreadId ()
2395 || !AttachThreadInput (GetCurrentThreadId (),
2396 foreground_thread, TRUE))
2397 foreground_thread = 0;
2399 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2400 if (child_thread == GetCurrentThreadId ()
2401 || !AttachThreadInput (GetCurrentThreadId (),
2402 child_thread, TRUE))
2403 child_thread = 0;
2405 /* Set the foreground window to the child. */
2406 if (SetForegroundWindow (cp->hwnd))
2408 /* Generate keystrokes as if user had typed Ctrl-Break or
2409 Ctrl-C. */
2410 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2411 keybd_event (vk_break_code, break_scan_code,
2412 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2413 keybd_event (vk_break_code, break_scan_code,
2414 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2415 | KEYEVENTF_KEYUP, 0);
2416 keybd_event (VK_CONTROL, control_scan_code,
2417 KEYEVENTF_KEYUP, 0);
2419 /* Sleep for a bit to give time for Emacs frame to respond
2420 to focus change events (if Emacs was active app). */
2421 Sleep (100);
2423 SetForegroundWindow (foreground_window);
2425 /* Detach from the foreground and child threads now that
2426 the foreground switching is over. */
2427 if (foreground_thread)
2428 AttachThreadInput (GetCurrentThreadId (),
2429 foreground_thread, FALSE);
2430 if (child_thread)
2431 AttachThreadInput (GetCurrentThreadId (),
2432 child_thread, FALSE);
2435 /* Ctrl-Break is NT equivalent of SIGINT. */
2436 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2438 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2439 "for pid %lu\n", GetLastError (), pid));
2440 errno = EINVAL;
2441 rc = -1;
2444 else
2446 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2448 #if 1
2449 if (os_subtype == OS_9X)
2452 Another possibility is to try terminating the VDM out-right by
2453 calling the Shell VxD (id 0x17) V86 interface, function #4
2454 "SHELL_Destroy_VM", ie.
2456 mov edx,4
2457 mov ebx,vm_handle
2458 call shellapi
2460 First need to determine the current VM handle, and then arrange for
2461 the shellapi call to be made from the system vm (by using
2462 Switch_VM_and_callback).
2464 Could try to invoke DestroyVM through CallVxD.
2467 #if 0
2468 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2469 to hang when cmdproxy is used in conjunction with
2470 command.com for an interactive shell. Posting
2471 WM_CLOSE pops up a dialog that, when Yes is selected,
2472 does the same thing. TerminateProcess is also less
2473 than ideal in that subprocesses tend to stick around
2474 until the machine is shutdown, but at least it
2475 doesn't freeze the 16-bit subsystem. */
2476 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2477 #endif
2478 if (!TerminateProcess (proc_hand, 0xff))
2480 DebPrint (("sys_kill.TerminateProcess returned %d "
2481 "for pid %lu\n", GetLastError (), pid));
2482 errno = EINVAL;
2483 rc = -1;
2486 else
2487 #endif
2488 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2490 /* Kill the process. On W32 this doesn't kill child processes
2491 so it doesn't work very well for shells which is why it's not
2492 used in every case. */
2493 else if (!TerminateProcess (proc_hand, 0xff))
2495 DebPrint (("sys_kill.TerminateProcess returned %d "
2496 "for pid %lu\n", GetLastError (), pid));
2497 errno = EINVAL;
2498 rc = -1;
2502 if (need_to_free)
2503 CloseHandle (proc_hand);
2505 return rc;
2508 /* The following two routines are used to manipulate stdin, stdout, and
2509 stderr of our child processes.
2511 Assuming that in, out, and err are *not* inheritable, we make them
2512 stdin, stdout, and stderr of the child as follows:
2514 - Save the parent's current standard handles.
2515 - Set the std handles to inheritable duplicates of the ones being passed in.
2516 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2517 NT file handle for a crt file descriptor.)
2518 - Spawn the child, which inherits in, out, and err as stdin,
2519 stdout, and stderr. (see Spawnve)
2520 - Close the std handles passed to the child.
2521 - Reset the parent's standard handles to the saved handles.
2522 (see reset_standard_handles)
2523 We assume that the caller closes in, out, and err after calling us. */
2525 void
2526 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2528 HANDLE parent;
2529 HANDLE newstdin, newstdout, newstderr;
2531 parent = GetCurrentProcess ();
2533 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2534 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2535 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2537 /* make inheritable copies of the new handles */
2538 if (!DuplicateHandle (parent,
2539 (HANDLE) _get_osfhandle (in),
2540 parent,
2541 &newstdin,
2543 TRUE,
2544 DUPLICATE_SAME_ACCESS))
2545 report_file_error ("Duplicating input handle for child", Qnil);
2547 if (!DuplicateHandle (parent,
2548 (HANDLE) _get_osfhandle (out),
2549 parent,
2550 &newstdout,
2552 TRUE,
2553 DUPLICATE_SAME_ACCESS))
2554 report_file_error ("Duplicating output handle for child", Qnil);
2556 if (!DuplicateHandle (parent,
2557 (HANDLE) _get_osfhandle (err),
2558 parent,
2559 &newstderr,
2561 TRUE,
2562 DUPLICATE_SAME_ACCESS))
2563 report_file_error ("Duplicating error handle for child", Qnil);
2565 /* and store them as our std handles */
2566 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2567 report_file_error ("Changing stdin handle", Qnil);
2569 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2570 report_file_error ("Changing stdout handle", Qnil);
2572 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2573 report_file_error ("Changing stderr handle", Qnil);
2576 void
2577 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2579 /* close the duplicated handles passed to the child */
2580 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2581 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2582 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2584 /* now restore parent's saved std handles */
2585 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2586 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2587 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2590 void
2591 set_process_dir (char * dir)
2593 process_dir = dir;
2596 /* To avoid problems with winsock implementations that work over dial-up
2597 connections causing or requiring a connection to exist while Emacs is
2598 running, Emacs no longer automatically loads winsock on startup if it
2599 is present. Instead, it will be loaded when open-network-stream is
2600 first called.
2602 To allow full control over when winsock is loaded, we provide these
2603 two functions to dynamically load and unload winsock. This allows
2604 dial-up users to only be connected when they actually need to use
2605 socket services. */
2607 /* From w32.c */
2608 extern HANDLE winsock_lib;
2609 extern BOOL term_winsock (void);
2610 extern BOOL init_winsock (int load_now);
2612 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2613 doc: /* Test for presence of the Windows socket library `winsock'.
2614 Returns non-nil if winsock support is present, nil otherwise.
2616 If the optional argument LOAD-NOW is non-nil, the winsock library is
2617 also loaded immediately if not already loaded. If winsock is loaded,
2618 the winsock local hostname is returned (since this may be different from
2619 the value of `system-name' and should supplant it), otherwise t is
2620 returned to indicate winsock support is present. */)
2621 (Lisp_Object load_now)
2623 int have_winsock;
2625 have_winsock = init_winsock (!NILP (load_now));
2626 if (have_winsock)
2628 if (winsock_lib != NULL)
2630 /* Return new value for system-name. The best way to do this
2631 is to call init_system_name, saving and restoring the
2632 original value to avoid side-effects. */
2633 Lisp_Object orig_hostname = Vsystem_name;
2634 Lisp_Object hostname;
2636 init_system_name ();
2637 hostname = Vsystem_name;
2638 Vsystem_name = orig_hostname;
2639 return hostname;
2641 return Qt;
2643 return Qnil;
2646 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2647 0, 0, 0,
2648 doc: /* Unload the Windows socket library `winsock' if loaded.
2649 This is provided to allow dial-up socket connections to be disconnected
2650 when no longer needed. Returns nil without unloading winsock if any
2651 socket connections still exist. */)
2652 (void)
2654 return term_winsock () ? Qt : Qnil;
2658 /* Some miscellaneous functions that are Windows specific, but not GUI
2659 specific (ie. are applicable in terminal or batch mode as well). */
2661 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2662 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2663 If FILENAME does not exist, return nil.
2664 All path elements in FILENAME are converted to their short names. */)
2665 (Lisp_Object filename)
2667 char shortname[MAX_PATH];
2669 CHECK_STRING (filename);
2671 /* first expand it. */
2672 filename = Fexpand_file_name (filename, Qnil);
2674 /* luckily, this returns the short version of each element in the path. */
2675 if (w32_get_short_filename (SDATA (ENCODE_FILE (filename)),
2676 shortname, MAX_PATH) == 0)
2677 return Qnil;
2679 dostounix_filename (shortname);
2681 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2682 return build_string (shortname);
2686 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2687 1, 1, 0,
2688 doc: /* Return the long file name version of the full path of FILENAME.
2689 If FILENAME does not exist, return nil.
2690 All path elements in FILENAME are converted to their long names. */)
2691 (Lisp_Object filename)
2693 char longname[ MAX_UTF8_PATH ];
2694 int drive_only = 0;
2696 CHECK_STRING (filename);
2698 if (SBYTES (filename) == 2
2699 && *(SDATA (filename) + 1) == ':')
2700 drive_only = 1;
2702 /* first expand it. */
2703 filename = Fexpand_file_name (filename, Qnil);
2705 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname,
2706 MAX_UTF8_PATH))
2707 return Qnil;
2709 dostounix_filename (longname);
2711 /* If we were passed only a drive, make sure that a slash is not appended
2712 for consistency with directories. Allow for drive mapping via SUBST
2713 in case expand-file-name is ever changed to expand those. */
2714 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2715 longname[2] = '\0';
2717 return DECODE_FILE (build_unibyte_string (longname));
2720 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2721 Sw32_set_process_priority, 2, 2, 0,
2722 doc: /* Set the priority of PROCESS to PRIORITY.
2723 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2724 priority of the process whose pid is PROCESS is changed.
2725 PRIORITY should be one of the symbols high, normal, or low;
2726 any other symbol will be interpreted as normal.
2728 If successful, the return value is t, otherwise nil. */)
2729 (Lisp_Object process, Lisp_Object priority)
2731 HANDLE proc_handle = GetCurrentProcess ();
2732 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2733 Lisp_Object result = Qnil;
2735 CHECK_SYMBOL (priority);
2737 if (!NILP (process))
2739 DWORD pid;
2740 child_process *cp;
2742 CHECK_NUMBER (process);
2744 /* Allow pid to be an internally generated one, or one obtained
2745 externally. This is necessary because real pids on Windows 95 are
2746 negative. */
2748 pid = XINT (process);
2749 cp = find_child_pid (pid);
2750 if (cp != NULL)
2751 pid = cp->procinfo.dwProcessId;
2753 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2756 if (EQ (priority, Qhigh))
2757 priority_class = HIGH_PRIORITY_CLASS;
2758 else if (EQ (priority, Qlow))
2759 priority_class = IDLE_PRIORITY_CLASS;
2761 if (proc_handle != NULL)
2763 if (SetPriorityClass (proc_handle, priority_class))
2764 result = Qt;
2765 if (!NILP (process))
2766 CloseHandle (proc_handle);
2769 return result;
2772 #ifdef HAVE_LANGINFO_CODESET
2773 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2774 char *
2775 nl_langinfo (nl_item item)
2777 /* Conversion of Posix item numbers to their Windows equivalents. */
2778 static const LCTYPE w32item[] = {
2779 LOCALE_IDEFAULTANSICODEPAGE,
2780 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2781 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2782 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2783 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2784 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2785 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2788 static char *nl_langinfo_buf = NULL;
2789 static int nl_langinfo_len = 0;
2791 if (nl_langinfo_len <= 0)
2792 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2794 if (item < 0 || item >= _NL_NUM)
2795 nl_langinfo_buf[0] = 0;
2796 else
2798 LCID cloc = GetThreadLocale ();
2799 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2800 NULL, 0);
2802 if (need_len <= 0)
2803 nl_langinfo_buf[0] = 0;
2804 else
2806 if (item == CODESET)
2808 need_len += 2; /* for the "cp" prefix */
2809 if (need_len < 8) /* for the case we call GetACP */
2810 need_len = 8;
2812 if (nl_langinfo_len <= need_len)
2813 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2814 nl_langinfo_len = need_len);
2815 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2816 nl_langinfo_buf, nl_langinfo_len))
2817 nl_langinfo_buf[0] = 0;
2818 else if (item == CODESET)
2820 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2821 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2822 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2823 else
2825 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2826 strlen (nl_langinfo_buf) + 1);
2827 nl_langinfo_buf[0] = 'c';
2828 nl_langinfo_buf[1] = 'p';
2833 return nl_langinfo_buf;
2835 #endif /* HAVE_LANGINFO_CODESET */
2837 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2838 Sw32_get_locale_info, 1, 2, 0,
2839 doc: /* Return information about the Windows locale LCID.
2840 By default, return a three letter locale code which encodes the default
2841 language as the first two characters, and the country or regional variant
2842 as the third letter. For example, ENU refers to `English (United States)',
2843 while ENC means `English (Canadian)'.
2845 If the optional argument LONGFORM is t, the long form of the locale
2846 name is returned, e.g. `English (United States)' instead; if LONGFORM
2847 is a number, it is interpreted as an LCTYPE constant and the corresponding
2848 locale information is returned.
2850 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2851 (Lisp_Object lcid, Lisp_Object longform)
2853 int got_abbrev;
2854 int got_full;
2855 char abbrev_name[32] = { 0 };
2856 char full_name[256] = { 0 };
2858 CHECK_NUMBER (lcid);
2860 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2861 return Qnil;
2863 if (NILP (longform))
2865 got_abbrev = GetLocaleInfo (XINT (lcid),
2866 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2867 abbrev_name, sizeof (abbrev_name));
2868 if (got_abbrev)
2869 return build_string (abbrev_name);
2871 else if (EQ (longform, Qt))
2873 got_full = GetLocaleInfo (XINT (lcid),
2874 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2875 full_name, sizeof (full_name));
2876 if (got_full)
2877 return DECODE_SYSTEM (build_string (full_name));
2879 else if (NUMBERP (longform))
2881 got_full = GetLocaleInfo (XINT (lcid),
2882 XINT (longform),
2883 full_name, sizeof (full_name));
2884 /* GetLocaleInfo's return value includes the terminating null
2885 character, when the returned information is a string, whereas
2886 make_unibyte_string needs the string length without the
2887 terminating null. */
2888 if (got_full)
2889 return make_unibyte_string (full_name, got_full - 1);
2892 return Qnil;
2896 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2897 Sw32_get_current_locale_id, 0, 0, 0,
2898 doc: /* Return Windows locale id for current locale setting.
2899 This is a numerical value; use `w32-get-locale-info' to convert to a
2900 human-readable form. */)
2901 (void)
2903 return make_number (GetThreadLocale ());
2906 static DWORD
2907 int_from_hex (char * s)
2909 DWORD val = 0;
2910 static char hex[] = "0123456789abcdefABCDEF";
2911 char * p;
2913 while (*s && (p = strchr (hex, *s)) != NULL)
2915 unsigned digit = p - hex;
2916 if (digit > 15)
2917 digit -= 6;
2918 val = val * 16 + digit;
2919 s++;
2921 return val;
2924 /* We need to build a global list, since the EnumSystemLocale callback
2925 function isn't given a context pointer. */
2926 Lisp_Object Vw32_valid_locale_ids;
2928 static BOOL CALLBACK ALIGN_STACK
2929 enum_locale_fn (LPTSTR localeNum)
2931 DWORD id = int_from_hex (localeNum);
2932 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2933 return TRUE;
2936 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2937 Sw32_get_valid_locale_ids, 0, 0, 0,
2938 doc: /* Return list of all valid Windows locale ids.
2939 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2940 human-readable form. */)
2941 (void)
2943 Vw32_valid_locale_ids = Qnil;
2945 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2947 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2948 return Vw32_valid_locale_ids;
2952 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2953 doc: /* Return Windows locale id for default locale setting.
2954 By default, the system default locale setting is returned; if the optional
2955 parameter USERP is non-nil, the user default locale setting is returned.
2956 This is a numerical value; use `w32-get-locale-info' to convert to a
2957 human-readable form. */)
2958 (Lisp_Object userp)
2960 if (NILP (userp))
2961 return make_number (GetSystemDefaultLCID ());
2962 return make_number (GetUserDefaultLCID ());
2966 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2967 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2968 If successful, the new locale id is returned, otherwise nil. */)
2969 (Lisp_Object lcid)
2971 CHECK_NUMBER (lcid);
2973 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2974 return Qnil;
2976 if (!SetThreadLocale (XINT (lcid)))
2977 return Qnil;
2979 /* Need to set input thread locale if present. */
2980 if (dwWindowsThreadId)
2981 /* Reply is not needed. */
2982 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2984 return make_number (GetThreadLocale ());
2988 /* We need to build a global list, since the EnumCodePages callback
2989 function isn't given a context pointer. */
2990 Lisp_Object Vw32_valid_codepages;
2992 static BOOL CALLBACK ALIGN_STACK
2993 enum_codepage_fn (LPTSTR codepageNum)
2995 DWORD id = atoi (codepageNum);
2996 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2997 return TRUE;
3000 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
3001 Sw32_get_valid_codepages, 0, 0, 0,
3002 doc: /* Return list of all valid Windows codepages. */)
3003 (void)
3005 Vw32_valid_codepages = Qnil;
3007 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
3009 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
3010 return Vw32_valid_codepages;
3014 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
3015 Sw32_get_console_codepage, 0, 0, 0,
3016 doc: /* Return current Windows codepage for console input. */)
3017 (void)
3019 return make_number (GetConsoleCP ());
3023 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
3024 Sw32_set_console_codepage, 1, 1, 0,
3025 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
3026 This codepage setting affects keyboard input in tty mode.
3027 If successful, the new CP is returned, otherwise nil. */)
3028 (Lisp_Object cp)
3030 CHECK_NUMBER (cp);
3032 if (!IsValidCodePage (XINT (cp)))
3033 return Qnil;
3035 if (!SetConsoleCP (XINT (cp)))
3036 return Qnil;
3038 return make_number (GetConsoleCP ());
3042 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
3043 Sw32_get_console_output_codepage, 0, 0, 0,
3044 doc: /* Return current Windows codepage for console output. */)
3045 (void)
3047 return make_number (GetConsoleOutputCP ());
3051 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
3052 Sw32_set_console_output_codepage, 1, 1, 0,
3053 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
3054 This codepage setting affects display in tty mode.
3055 If successful, the new CP is returned, otherwise nil. */)
3056 (Lisp_Object cp)
3058 CHECK_NUMBER (cp);
3060 if (!IsValidCodePage (XINT (cp)))
3061 return Qnil;
3063 if (!SetConsoleOutputCP (XINT (cp)))
3064 return Qnil;
3066 return make_number (GetConsoleOutputCP ());
3070 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
3071 Sw32_get_codepage_charset, 1, 1, 0,
3072 doc: /* Return charset ID corresponding to codepage CP.
3073 Returns nil if the codepage is not valid or its charset ID could
3074 not be determined.
3076 Note that this function is only guaranteed to work with ANSI
3077 codepages; most console codepages are not supported and will
3078 yield nil. */)
3079 (Lisp_Object cp)
3081 CHARSETINFO info;
3083 CHECK_NUMBER (cp);
3085 if (!IsValidCodePage (XINT (cp)))
3086 return Qnil;
3088 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
3089 return make_number (info.ciCharset);
3091 return Qnil;
3095 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
3096 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
3097 doc: /* Return list of Windows keyboard languages and layouts.
3098 The return value is a list of pairs of language id and layout id. */)
3099 (void)
3101 int num_layouts = GetKeyboardLayoutList (0, NULL);
3102 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
3103 Lisp_Object obj = Qnil;
3105 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
3107 while (--num_layouts >= 0)
3109 HKL kl = layouts[num_layouts];
3111 obj = Fcons (Fcons (make_number (LOWORD (kl)),
3112 make_number (HIWORD (kl))),
3113 obj);
3117 return obj;
3121 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
3122 Sw32_get_keyboard_layout, 0, 0, 0,
3123 doc: /* Return current Windows keyboard language and layout.
3124 The return value is the cons of the language id and the layout id. */)
3125 (void)
3127 HKL kl = GetKeyboardLayout (dwWindowsThreadId);
3129 return Fcons (make_number (LOWORD (kl)),
3130 make_number (HIWORD (kl)));
3134 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
3135 Sw32_set_keyboard_layout, 1, 1, 0,
3136 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
3137 The keyboard layout setting affects interpretation of keyboard input.
3138 If successful, the new layout id is returned, otherwise nil. */)
3139 (Lisp_Object layout)
3141 HKL kl;
3143 CHECK_CONS (layout);
3144 CHECK_NUMBER_CAR (layout);
3145 CHECK_NUMBER_CDR (layout);
3147 kl = (HKL) ((XINT (XCAR (layout)) & 0xffff)
3148 | (XINT (XCDR (layout)) << 16));
3150 /* Synchronize layout with input thread. */
3151 if (dwWindowsThreadId)
3153 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
3154 (WPARAM) kl, 0))
3156 MSG msg;
3157 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3159 if (msg.wParam == 0)
3160 return Qnil;
3163 else if (!ActivateKeyboardLayout (kl, 0))
3164 return Qnil;
3166 return Fw32_get_keyboard_layout ();
3169 /* Two variables to interface between get_lcid and the EnumLocales
3170 callback function below. */
3171 #ifndef LOCALE_NAME_MAX_LENGTH
3172 # define LOCALE_NAME_MAX_LENGTH 85
3173 #endif
3174 static LCID found_lcid;
3175 static char lname[3 * LOCALE_NAME_MAX_LENGTH + 1 + 1];
3177 /* Callback function for EnumLocales. */
3178 static BOOL CALLBACK
3179 get_lcid_callback (LPTSTR locale_num_str)
3181 char *endp;
3182 char locval[2 * LOCALE_NAME_MAX_LENGTH + 1 + 1];
3183 LCID try_lcid = strtoul (locale_num_str, &endp, 16);
3185 if (GetLocaleInfo (try_lcid, LOCALE_SABBREVLANGNAME,
3186 locval, LOCALE_NAME_MAX_LENGTH))
3188 size_t locval_len;
3190 /* This is for when they only specify the language, as in "ENU". */
3191 if (stricmp (locval, lname) == 0)
3193 found_lcid = try_lcid;
3194 return FALSE;
3196 locval_len = strlen (locval);
3197 strcpy (locval + locval_len, "_");
3198 if (GetLocaleInfo (try_lcid, LOCALE_SABBREVCTRYNAME,
3199 locval + locval_len + 1, LOCALE_NAME_MAX_LENGTH))
3201 locval_len = strlen (locval);
3202 if (strnicmp (locval, lname, locval_len) == 0
3203 && (lname[locval_len] == '.'
3204 || lname[locval_len] == '\0'))
3206 found_lcid = try_lcid;
3207 return FALSE;
3211 return TRUE;
3214 /* Return the Locale ID (LCID) number given the locale's name, a
3215 string, in LOCALE_NAME. This works by enumerating all the locales
3216 supported by the system, until we find one whose name matches
3217 LOCALE_NAME. */
3218 static LCID
3219 get_lcid (const char *locale_name)
3221 /* A simple cache. */
3222 static LCID last_lcid;
3223 static char last_locale[1000];
3225 /* The code below is not thread-safe, as it uses static variables.
3226 But this function is called only from the Lisp thread. */
3227 if (last_lcid > 0 && strcmp (locale_name, last_locale) == 0)
3228 return last_lcid;
3230 strncpy (lname, locale_name, sizeof (lname) - 1);
3231 lname[sizeof (lname) - 1] = '\0';
3232 found_lcid = 0;
3233 EnumSystemLocales (get_lcid_callback, LCID_SUPPORTED);
3234 if (found_lcid > 0)
3236 last_lcid = found_lcid;
3237 strcpy (last_locale, locale_name);
3239 return found_lcid;
3242 #ifndef _NSLCMPERROR
3243 # define _NSLCMPERROR INT_MAX
3244 #endif
3245 #ifndef LINGUISTIC_IGNORECASE
3246 # define LINGUISTIC_IGNORECASE 0x00000010
3247 #endif
3250 w32_compare_strings (const char *s1, const char *s2, char *locname,
3251 int ignore_case)
3253 LCID lcid = GetThreadLocale ();
3254 wchar_t *string1_w, *string2_w;
3255 int val, needed;
3256 extern BOOL g_b_init_compare_string_w;
3257 static int (WINAPI *pCompareStringW)(LCID, DWORD, LPCWSTR, int, LPCWSTR, int);
3258 DWORD flags = 0;
3260 USE_SAFE_ALLOCA;
3262 /* The LCID machinery doesn't seem to support the "C" locale, so we
3263 need to do that by hand. */
3264 if (locname
3265 && ((locname[0] == 'C' && (locname[1] == '\0' || locname[1] == '.'))
3266 || strcmp (locname, "POSIX") == 0))
3267 return (ignore_case ? stricmp (s1, s2) : strcmp (s1, s2));
3269 if (!g_b_init_compare_string_w)
3271 if (os_subtype == OS_9X)
3273 pCompareStringW = GetProcAddress (LoadLibrary ("Unicows.dll"),
3274 "CompareStringW");
3275 if (!pCompareStringW)
3277 errno = EINVAL;
3278 /* This return value is compatible with wcscoll and
3279 other MS CRT functions. */
3280 return _NSLCMPERROR;
3283 else
3284 pCompareStringW = CompareStringW;
3286 g_b_init_compare_string_w = 1;
3289 needed = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s1, -1, NULL, 0);
3290 if (needed > 0)
3292 SAFE_NALLOCA (string1_w, 1, needed + 1);
3293 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s1, -1,
3294 string1_w, needed);
3296 else
3298 errno = EINVAL;
3299 return _NSLCMPERROR;
3302 needed = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s2, -1, NULL, 0);
3303 if (needed > 0)
3305 SAFE_NALLOCA (string2_w, 1, needed + 1);
3306 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS, s2, -1,
3307 string2_w, needed);
3309 else
3311 SAFE_FREE ();
3312 errno = EINVAL;
3313 return _NSLCMPERROR;
3316 if (locname)
3318 /* Convert locale name string to LCID. We don't want to use
3319 LocaleNameToLCID because (a) it is only available since
3320 Vista, and (b) it doesn't accept locale names returned by
3321 'setlocale' and 'GetLocaleInfo'. */
3322 LCID new_lcid = get_lcid (locname);
3324 if (new_lcid > 0)
3325 lcid = new_lcid;
3326 else
3327 error ("Invalid locale %s: Invalid argument", locname);
3330 if (ignore_case)
3332 /* NORM_IGNORECASE ignores any tertiary distinction, not just
3333 case variants. LINGUISTIC_IGNORECASE is more selective, and
3334 is sensitive to the locale's language, but it is not
3335 available before Vista. */
3336 if (w32_major_version >= 6)
3337 flags |= LINGUISTIC_IGNORECASE;
3338 else
3339 flags |= NORM_IGNORECASE;
3341 /* This approximates what glibc collation functions do when the
3342 locale's codeset is UTF-8. */
3343 if (!NILP (Vw32_collate_ignore_punctuation))
3344 flags |= NORM_IGNORESYMBOLS;
3345 val = pCompareStringW (lcid, flags, string1_w, -1, string2_w, -1);
3346 SAFE_FREE ();
3347 if (!val)
3349 errno = EINVAL;
3350 return _NSLCMPERROR;
3352 return val - 2;
3356 void
3357 syms_of_ntproc (void)
3359 DEFSYM (Qhigh, "high");
3360 DEFSYM (Qlow, "low");
3362 defsubr (&Sw32_has_winsock);
3363 defsubr (&Sw32_unload_winsock);
3365 defsubr (&Sw32_short_file_name);
3366 defsubr (&Sw32_long_file_name);
3367 defsubr (&Sw32_set_process_priority);
3368 defsubr (&Sw32_get_locale_info);
3369 defsubr (&Sw32_get_current_locale_id);
3370 defsubr (&Sw32_get_default_locale_id);
3371 defsubr (&Sw32_get_valid_locale_ids);
3372 defsubr (&Sw32_set_current_locale);
3374 defsubr (&Sw32_get_console_codepage);
3375 defsubr (&Sw32_set_console_codepage);
3376 defsubr (&Sw32_get_console_output_codepage);
3377 defsubr (&Sw32_set_console_output_codepage);
3378 defsubr (&Sw32_get_valid_codepages);
3379 defsubr (&Sw32_get_codepage_charset);
3381 defsubr (&Sw32_get_valid_keyboard_layouts);
3382 defsubr (&Sw32_get_keyboard_layout);
3383 defsubr (&Sw32_set_keyboard_layout);
3385 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3386 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3387 Because Windows does not directly pass argv arrays to child processes,
3388 programs have to reconstruct the argv array by parsing the command
3389 line string. For an argument to contain a space, it must be enclosed
3390 in double quotes or it will be parsed as multiple arguments.
3392 If the value is a character, that character will be used to escape any
3393 quote characters that appear, otherwise a suitable escape character
3394 will be chosen based on the type of the program. */);
3395 Vw32_quote_process_args = Qt;
3397 DEFVAR_LISP ("w32-start-process-show-window",
3398 Vw32_start_process_show_window,
3399 doc: /* When nil, new child processes hide their windows.
3400 When non-nil, they show their window in the method of their choice.
3401 This variable doesn't affect GUI applications, which will never be hidden. */);
3402 Vw32_start_process_show_window = Qnil;
3404 DEFVAR_LISP ("w32-start-process-share-console",
3405 Vw32_start_process_share_console,
3406 doc: /* When nil, new child processes are given a new console.
3407 When non-nil, they share the Emacs console; this has the limitation of
3408 allowing only one DOS subprocess to run at a time (whether started directly
3409 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3410 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3411 otherwise respond to interrupts from Emacs. */);
3412 Vw32_start_process_share_console = Qnil;
3414 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3415 Vw32_start_process_inherit_error_mode,
3416 doc: /* When nil, new child processes revert to the default error mode.
3417 When non-nil, they inherit their error mode setting from Emacs, which stops
3418 them blocking when trying to access unmounted drives etc. */);
3419 Vw32_start_process_inherit_error_mode = Qt;
3421 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3422 doc: /* Forced delay before reading subprocess output.
3423 This is done to improve the buffering of subprocess output, by
3424 avoiding the inefficiency of frequently reading small amounts of data.
3426 If positive, the value is the number of milliseconds to sleep before
3427 reading the subprocess output. If negative, the magnitude is the number
3428 of time slices to wait (effectively boosting the priority of the child
3429 process temporarily). A value of zero disables waiting entirely. */);
3430 w32_pipe_read_delay = 50;
3432 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3433 doc: /* Non-nil means convert all-upper case file names to lower case.
3434 This applies when performing completions and file name expansion.
3435 Note that the value of this setting also affects remote file names,
3436 so you probably don't want to set to non-nil if you use case-sensitive
3437 filesystems via ange-ftp. */);
3438 Vw32_downcase_file_names = Qnil;
3440 #if 0
3441 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3442 doc: /* Non-nil means attempt to fake realistic inode values.
3443 This works by hashing the truename of files, and should detect
3444 aliasing between long and short (8.3 DOS) names, but can have
3445 false positives because of hash collisions. Note that determining
3446 the truename of a file can be slow. */);
3447 Vw32_generate_fake_inodes = Qnil;
3448 #endif
3450 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3451 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3452 This option controls whether to issue additional system calls to determine
3453 accurate link counts, file type, and ownership information. It is more
3454 useful for files on NTFS volumes, where hard links and file security are
3455 supported, than on volumes of the FAT family.
3457 Without these system calls, link count will always be reported as 1 and file
3458 ownership will be attributed to the current user.
3459 The default value `local' means only issue these system calls for files
3460 on local fixed drives. A value of nil means never issue them.
3461 Any other non-nil value means do this even on remote and removable drives
3462 where the performance impact may be noticeable even on modern hardware. */);
3463 Vw32_get_true_file_attributes = Qlocal;
3465 DEFVAR_LISP ("w32-collate-ignore-punctuation",
3466 Vw32_collate_ignore_punctuation,
3467 doc: /* Non-nil causes string collation functions ignore punctuation on MS-Windows.
3468 On Posix platforms, `string-collate-lessp' and `string-collate-equalp'
3469 ignore punctuation characters when they compare strings, if the
3470 locale's codeset is UTF-8, as in \"en_US.UTF-8\". Binding this option
3471 to a non-nil value will achieve a similar effect on MS-Windows, where
3472 locales with UTF-8 codeset are not supported.
3474 Note that setting this to non-nil will also ignore blanks and symbols
3475 in the strings. So do NOT use this option when comparing file names
3476 for equality, only when you need to sort them. */);
3477 Vw32_collate_ignore_punctuation = Qnil;
3479 staticpro (&Vw32_valid_locale_ids);
3480 staticpro (&Vw32_valid_codepages);
3482 /* end of w32proc.c */