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