Merge from trunk after a lot of time.
[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 /* Last opportunity to avoid leaking handles before we forget them
853 for good. */
854 if (cp->procinfo.hProcess)
855 CloseHandle (cp->procinfo.hProcess);
856 if (cp->procinfo.hThread)
857 CloseHandle (cp->procinfo.hThread);
858 memset (cp, 0, sizeof (*cp));
859 cp->fd = -1;
860 cp->pid = -1;
861 cp->procinfo.hProcess = NULL;
862 cp->status = STATUS_READ_ERROR;
863 cp->input_file = NULL;
864 cp->pending_deletion = 0;
865
866 /* use manual reset event so that select() will function properly */
867 cp->char_avail = CreateEvent (NULL, TRUE, FALSE, NULL);
868 if (cp->char_avail)
869 {
870 cp->char_consumed = CreateEvent (NULL, FALSE, FALSE, NULL);
871 if (cp->char_consumed)
872 {
873 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
874 It means that the 64K stack we are requesting in the 2nd
875 argument is how much memory should be reserved for the
876 stack. If we don't use this flag, the memory requested
877 by the 2nd argument is the amount actually _committed_,
878 but Windows reserves 8MB of memory for each thread's
879 stack. (The 8MB figure comes from the -stack
880 command-line argument we pass to the linker when building
881 Emacs, but that's because we need a large stack for
882 Emacs's main thread.) Since we request 2GB of reserved
883 memory at startup (see w32heap.c), which is close to the
884 maximum memory available for a 32-bit process on Windows,
885 the 8MB reservation for each thread causes failures in
886 starting subprocesses, because we create a thread running
887 reader_thread for each subprocess. As 8MB of stack is
888 way too much for reader_thread, forcing Windows to
889 reserve less wins the day. */
890 cp->thrd = CreateThread (NULL, 64 * 1024, reader_thread, cp,
891 0x00010000, &id);
892 if (cp->thrd)
893 return cp;
894 }
895 }
896 delete_child (cp);
897 return NULL;
898 }
899
900 void
901 delete_child (child_process *cp)
902 {
903 int i;
904
905 /* Should not be deleting a child that is still needed. */
906 for (i = 0; i < MAXDESC; i++)
907 if (fd_info[i].cp == cp)
908 emacs_abort ();
909
910 if (!CHILD_ACTIVE (cp) && cp->procinfo.hProcess == NULL)
911 return;
912
913 /* Delete the child's temporary input file, if any, that is pending
914 deletion. */
915 if (cp->input_file)
916 {
917 if (cp->pending_deletion)
918 {
919 if (unlink (cp->input_file))
920 DebPrint (("delete_child.unlink (%s) failed, errno: %d\n",
921 cp->input_file, errno));
922 cp->pending_deletion = 0;
923 }
924 xfree (cp->input_file);
925 cp->input_file = NULL;
926 }
927
928 /* reap thread if necessary */
929 if (cp->thrd)
930 {
931 DWORD rc;
932
933 if (GetExitCodeThread (cp->thrd, &rc) && rc == STILL_ACTIVE)
934 {
935 /* let the thread exit cleanly if possible */
936 cp->status = STATUS_READ_ERROR;
937 SetEvent (cp->char_consumed);
938 #if 0
939 /* We used to forcibly terminate the thread here, but it
940 is normally unnecessary, and in abnormal cases, the worst that
941 will happen is we have an extra idle thread hanging around
942 waiting for the zombie process. */
943 if (WaitForSingleObject (cp->thrd, 1000) != WAIT_OBJECT_0)
944 {
945 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
946 "with %lu for fd %ld\n", GetLastError (), cp->fd));
947 TerminateThread (cp->thrd, 0);
948 }
949 #endif
950 }
951 CloseHandle (cp->thrd);
952 cp->thrd = NULL;
953 }
954 if (cp->char_avail)
955 {
956 CloseHandle (cp->char_avail);
957 cp->char_avail = NULL;
958 }
959 if (cp->char_consumed)
960 {
961 CloseHandle (cp->char_consumed);
962 cp->char_consumed = NULL;
963 }
964
965 /* update child_proc_count (highest numbered slot in use plus one) */
966 if (cp == child_procs + child_proc_count - 1)
967 {
968 for (i = child_proc_count-1; i >= 0; i--)
969 if (CHILD_ACTIVE (&child_procs[i])
970 || child_procs[i].procinfo.hProcess != NULL)
971 {
972 child_proc_count = i + 1;
973 break;
974 }
975 }
976 if (i < 0)
977 child_proc_count = 0;
978 }
979
980 /* Find a child by pid. */
981 static child_process *
982 find_child_pid (DWORD pid)
983 {
984 child_process *cp;
985
986 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
987 if ((CHILD_ACTIVE (cp) || cp->procinfo.hProcess != NULL)
988 && pid == cp->pid)
989 return cp;
990 return NULL;
991 }
992
993 void
994 release_listen_threads (void)
995 {
996 int i;
997
998 for (i = child_proc_count - 1; i >= 0; i--)
999 {
1000 if (CHILD_ACTIVE (&child_procs[i])
1001 && (fd_info[child_procs[i].fd].flags & FILE_LISTEN))
1002 child_procs[i].status = STATUS_READ_ERROR;
1003 }
1004 }
1005
1006 /* Thread proc for child process and socket reader threads. Each thread
1007 is normally blocked until woken by select() to check for input by
1008 reading one char. When the read completes, char_avail is signaled
1009 to wake up the select emulator and the thread blocks itself again. */
1010 static DWORD WINAPI
1011 reader_thread (void *arg)
1012 {
1013 child_process *cp;
1014
1015 /* Our identity */
1016 cp = (child_process *)arg;
1017
1018 /* We have to wait for the go-ahead before we can start */
1019 if (cp == NULL
1020 || WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0
1021 || cp->fd < 0)
1022 return 1;
1023
1024 for (;;)
1025 {
1026 int rc;
1027
1028 if (cp->fd >= 0 && fd_info[cp->fd].flags & FILE_LISTEN)
1029 rc = _sys_wait_accept (cp->fd);
1030 else
1031 rc = _sys_read_ahead (cp->fd);
1032
1033 /* Don't bother waiting for the event if we already have been
1034 told to exit by delete_child. */
1035 if (cp->status == STATUS_READ_ERROR || !cp->char_avail)
1036 break;
1037
1038 /* The name char_avail is a misnomer - it really just means the
1039 read-ahead has completed, whether successfully or not. */
1040 if (!SetEvent (cp->char_avail))
1041 {
1042 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1043 (DWORD_PTR)cp->char_avail, GetLastError (),
1044 cp->fd, cp->pid));
1045 return 1;
1046 }
1047
1048 if (rc == STATUS_READ_ERROR)
1049 return 1;
1050
1051 /* If the read died, the child has died so let the thread die */
1052 if (rc == STATUS_READ_FAILED)
1053 break;
1054
1055 /* Don't bother waiting for the acknowledge if we already have
1056 been told to exit by delete_child. */
1057 if (cp->status == STATUS_READ_ERROR || !cp->char_consumed)
1058 break;
1059
1060 /* Wait until our input is acknowledged before reading again */
1061 if (WaitForSingleObject (cp->char_consumed, INFINITE) != WAIT_OBJECT_0)
1062 {
1063 DebPrint (("reader_thread.WaitForSingleObject failed with "
1064 "%lu for fd %ld\n", GetLastError (), cp->fd));
1065 break;
1066 }
1067 /* delete_child sets status to STATUS_READ_ERROR when it wants
1068 us to exit. */
1069 if (cp->status == STATUS_READ_ERROR)
1070 break;
1071 }
1072 return 0;
1073 }
1074
1075 /* To avoid Emacs changing directory, we just record here the directory
1076 the new process should start in. This is set just before calling
1077 sys_spawnve, and is not generally valid at any other time. */
1078 static char * process_dir;
1079
1080 static BOOL
1081 create_child (char *exe, char *cmdline, char *env, int is_gui_app,
1082 int * pPid, child_process *cp)
1083 {
1084 STARTUPINFO start;
1085 SECURITY_ATTRIBUTES sec_attrs;
1086 #if 0
1087 SECURITY_DESCRIPTOR sec_desc;
1088 #endif
1089 DWORD flags;
1090 char dir[ MAXPATHLEN ];
1091
1092 if (cp == NULL) emacs_abort ();
1093
1094 memset (&start, 0, sizeof (start));
1095 start.cb = sizeof (start);
1096
1097 #ifdef HAVE_NTGUI
1098 if (NILP (Vw32_start_process_show_window) && !is_gui_app)
1099 start.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
1100 else
1101 start.dwFlags = STARTF_USESTDHANDLES;
1102 start.wShowWindow = SW_HIDE;
1103
1104 start.hStdInput = GetStdHandle (STD_INPUT_HANDLE);
1105 start.hStdOutput = GetStdHandle (STD_OUTPUT_HANDLE);
1106 start.hStdError = GetStdHandle (STD_ERROR_HANDLE);
1107 #endif /* HAVE_NTGUI */
1108
1109 #if 0
1110 /* Explicitly specify no security */
1111 if (!InitializeSecurityDescriptor (&sec_desc, SECURITY_DESCRIPTOR_REVISION))
1112 goto EH_Fail;
1113 if (!SetSecurityDescriptorDacl (&sec_desc, TRUE, NULL, FALSE))
1114 goto EH_Fail;
1115 #endif
1116 sec_attrs.nLength = sizeof (sec_attrs);
1117 sec_attrs.lpSecurityDescriptor = NULL /* &sec_desc */;
1118 sec_attrs.bInheritHandle = FALSE;
1119
1120 strcpy (dir, process_dir);
1121 unixtodos_filename (dir);
1122
1123 flags = (!NILP (Vw32_start_process_share_console)
1124 ? CREATE_NEW_PROCESS_GROUP
1125 : CREATE_NEW_CONSOLE);
1126 if (NILP (Vw32_start_process_inherit_error_mode))
1127 flags |= CREATE_DEFAULT_ERROR_MODE;
1128 if (!CreateProcess (exe, cmdline, &sec_attrs, NULL, TRUE,
1129 flags, env, dir, &start, &cp->procinfo))
1130 goto EH_Fail;
1131
1132 cp->pid = (int) cp->procinfo.dwProcessId;
1133
1134 /* Hack for Windows 95, which assigns large (ie negative) pids */
1135 if (cp->pid < 0)
1136 cp->pid = -cp->pid;
1137
1138 *pPid = cp->pid;
1139
1140 return TRUE;
1141
1142 EH_Fail:
1143 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1144 return FALSE;
1145 }
1146
1147 /* create_child doesn't know what emacs' file handle will be for waiting
1148 on output from the child, so we need to make this additional call
1149 to register the handle with the process
1150 This way the select emulator knows how to match file handles with
1151 entries in child_procs. */
1152 void
1153 register_child (pid_t pid, int fd)
1154 {
1155 child_process *cp;
1156
1157 cp = find_child_pid ((DWORD)pid);
1158 if (cp == NULL)
1159 {
1160 DebPrint (("register_child unable to find pid %lu\n", pid));
1161 return;
1162 }
1163
1164 #ifdef FULL_DEBUG
1165 DebPrint (("register_child registered fd %d with pid %lu\n", fd, pid));
1166 #endif
1167
1168 cp->fd = fd;
1169
1170 /* thread is initially blocked until select is called; set status so
1171 that select will release thread */
1172 cp->status = STATUS_READ_ACKNOWLEDGED;
1173
1174 /* attach child_process to fd_info */
1175 if (fd_info[fd].cp != NULL)
1176 {
1177 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd));
1178 emacs_abort ();
1179 }
1180
1181 fd_info[fd].cp = cp;
1182 }
1183
1184 /* Record INFILE as an input file for process PID. */
1185 void
1186 record_infile (pid_t pid, char *infile)
1187 {
1188 child_process *cp;
1189
1190 /* INFILE should never be NULL, since xstrdup would have signaled
1191 memory full condition in that case, see callproc.c where this
1192 function is called. */
1193 eassert (infile);
1194
1195 cp = find_child_pid ((DWORD)pid);
1196 if (cp == NULL)
1197 {
1198 DebPrint (("record_infile is unable to find pid %lu\n", pid));
1199 return;
1200 }
1201
1202 cp->input_file = infile;
1203 }
1204
1205 /* Mark the input file INFILE of the corresponding subprocess as
1206 temporary, to be deleted when the subprocess exits. */
1207 void
1208 record_pending_deletion (char *infile)
1209 {
1210 child_process *cp;
1211
1212 eassert (infile);
1213
1214 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1215 if (CHILD_ACTIVE (cp)
1216 && cp->input_file && xstrcasecmp (cp->input_file, infile) == 0)
1217 {
1218 cp->pending_deletion = 1;
1219 break;
1220 }
1221 }
1222
1223 /* Called from waitpid when a process exits. */
1224 static void
1225 reap_subprocess (child_process *cp)
1226 {
1227 if (cp->procinfo.hProcess)
1228 {
1229 /* Reap the process */
1230 #ifdef FULL_DEBUG
1231 /* Process should have already died before we are called. */
1232 if (WaitForSingleObject (cp->procinfo.hProcess, 0) != WAIT_OBJECT_0)
1233 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp->fd));
1234 #endif
1235 CloseHandle (cp->procinfo.hProcess);
1236 cp->procinfo.hProcess = NULL;
1237 CloseHandle (cp->procinfo.hThread);
1238 cp->procinfo.hThread = NULL;
1239 }
1240
1241 /* If cp->fd was not closed yet, we might be still reading the
1242 process output, so don't free its resources just yet. The call
1243 to delete_child on behalf of this subprocess will be made by
1244 sys_read when the subprocess output is fully read. */
1245 if (cp->fd < 0)
1246 delete_child (cp);
1247 }
1248
1249 /* Wait for a child process specified by PID, or for any of our
1250 existing child processes (if PID is nonpositive) to die. When it
1251 does, close its handle. Return the pid of the process that died
1252 and fill in STATUS if non-NULL. */
1253
1254 pid_t
1255 waitpid (pid_t pid, int *status, int options)
1256 {
1257 DWORD active, retval;
1258 int nh;
1259 child_process *cp, *cps[MAX_CHILDREN];
1260 HANDLE wait_hnd[MAX_CHILDREN];
1261 DWORD timeout_ms;
1262 int dont_wait = (options & WNOHANG) != 0;
1263
1264 nh = 0;
1265 /* According to Posix:
1266
1267 PID = -1 means status is requested for any child process.
1268
1269 PID > 0 means status is requested for a single child process
1270 whose pid is PID.
1271
1272 PID = 0 means status is requested for any child process whose
1273 process group ID is equal to that of the calling process. But
1274 since Windows has only a limited support for process groups (only
1275 for console processes and only for the purposes of passing
1276 Ctrl-BREAK signal to them), and since we have no documented way
1277 of determining whether a given process belongs to our group, we
1278 treat 0 as -1.
1279
1280 PID < -1 means status is requested for any child process whose
1281 process group ID is equal to the absolute value of PID. Again,
1282 since we don't support process groups, we treat that as -1. */
1283 if (pid > 0)
1284 {
1285 int our_child = 0;
1286
1287 /* We are requested to wait for a specific child. */
1288 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1289 {
1290 /* Some child_procs might be sockets; ignore them. Also
1291 ignore subprocesses whose output is not yet completely
1292 read. */
1293 if (CHILD_ACTIVE (cp)
1294 && cp->procinfo.hProcess
1295 && cp->pid == pid)
1296 {
1297 our_child = 1;
1298 break;
1299 }
1300 }
1301 if (our_child)
1302 {
1303 if (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
1304 {
1305 wait_hnd[nh] = cp->procinfo.hProcess;
1306 cps[nh] = cp;
1307 nh++;
1308 }
1309 else if (dont_wait)
1310 {
1311 /* PID specifies our subprocess, but its status is not
1312 yet available. */
1313 return 0;
1314 }
1315 }
1316 if (nh == 0)
1317 {
1318 /* No such child process, or nothing to wait for, so fail. */
1319 errno = ECHILD;
1320 return -1;
1321 }
1322 }
1323 else
1324 {
1325 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
1326 {
1327 if (CHILD_ACTIVE (cp)
1328 && cp->procinfo.hProcess
1329 && (cp->fd < 0 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0))
1330 {
1331 wait_hnd[nh] = cp->procinfo.hProcess;
1332 cps[nh] = cp;
1333 nh++;
1334 }
1335 }
1336 if (nh == 0)
1337 {
1338 /* Nothing to wait on, so fail. */
1339 errno = ECHILD;
1340 return -1;
1341 }
1342 }
1343
1344 if (dont_wait)
1345 timeout_ms = 0;
1346 else
1347 timeout_ms = 1000; /* check for quit about once a second. */
1348
1349 do
1350 {
1351 QUIT;
1352 active = WaitForMultipleObjects (nh, wait_hnd, FALSE, timeout_ms);
1353 } while (active == WAIT_TIMEOUT && !dont_wait);
1354
1355 if (active == WAIT_FAILED)
1356 {
1357 errno = EBADF;
1358 return -1;
1359 }
1360 else if (active == WAIT_TIMEOUT && dont_wait)
1361 {
1362 /* PID specifies our subprocess, but it didn't exit yet, so its
1363 status is not yet available. */
1364 #ifdef FULL_DEBUG
1365 DebPrint (("Wait: PID %d not reap yet\n", cp->pid));
1366 #endif
1367 return 0;
1368 }
1369 else if (active >= WAIT_OBJECT_0
1370 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
1371 {
1372 active -= WAIT_OBJECT_0;
1373 }
1374 else if (active >= WAIT_ABANDONED_0
1375 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
1376 {
1377 active -= WAIT_ABANDONED_0;
1378 }
1379 else
1380 emacs_abort ();
1381
1382 if (!GetExitCodeProcess (wait_hnd[active], &retval))
1383 {
1384 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1385 GetLastError ()));
1386 retval = 1;
1387 }
1388 if (retval == STILL_ACTIVE)
1389 {
1390 /* Should never happen. */
1391 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1392 if (pid > 0 && dont_wait)
1393 return 0;
1394 errno = EINVAL;
1395 return -1;
1396 }
1397
1398 /* Massage the exit code from the process to match the format expected
1399 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1400 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1401
1402 if (retval == STATUS_CONTROL_C_EXIT)
1403 retval = SIGINT;
1404 else
1405 retval <<= 8;
1406
1407 if (pid > 0 && active != 0)
1408 emacs_abort ();
1409 cp = cps[active];
1410 pid = cp->pid;
1411 #ifdef FULL_DEBUG
1412 DebPrint (("Wait signaled with process pid %d\n", cp->pid));
1413 #endif
1414
1415 if (status)
1416 *status = retval;
1417 reap_subprocess (cp);
1418
1419 return pid;
1420 }
1421
1422 /* Old versions of w32api headers don't have separate 32-bit and
1423 64-bit defines, but the one they have matches the 32-bit variety. */
1424 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1425 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1426 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1427 #endif
1428
1429 static void
1430 w32_executable_type (char * filename,
1431 int * is_dos_app,
1432 int * is_cygnus_app,
1433 int * is_gui_app)
1434 {
1435 file_data executable;
1436 char * p;
1437
1438 /* Default values in case we can't tell for sure. */
1439 *is_dos_app = FALSE;
1440 *is_cygnus_app = FALSE;
1441 *is_gui_app = FALSE;
1442
1443 if (!open_input_file (&executable, filename))
1444 return;
1445
1446 p = strrchr (filename, '.');
1447
1448 /* We can only identify DOS .com programs from the extension. */
1449 if (p && xstrcasecmp (p, ".com") == 0)
1450 *is_dos_app = TRUE;
1451 else if (p && (xstrcasecmp (p, ".bat") == 0
1452 || xstrcasecmp (p, ".cmd") == 0))
1453 {
1454 /* A DOS shell script - it appears that CreateProcess is happy to
1455 accept this (somewhat surprisingly); presumably it looks at
1456 COMSPEC to determine what executable to actually invoke.
1457 Therefore, we have to do the same here as well. */
1458 /* Actually, I think it uses the program association for that
1459 extension, which is defined in the registry. */
1460 p = egetenv ("COMSPEC");
1461 if (p)
1462 w32_executable_type (p, is_dos_app, is_cygnus_app, is_gui_app);
1463 }
1464 else
1465 {
1466 /* Look for DOS .exe signature - if found, we must also check that
1467 it isn't really a 16- or 32-bit Windows exe, since both formats
1468 start with a DOS program stub. Note that 16-bit Windows
1469 executables use the OS/2 1.x format. */
1470
1471 IMAGE_DOS_HEADER * dos_header;
1472 IMAGE_NT_HEADERS * nt_header;
1473
1474 dos_header = (PIMAGE_DOS_HEADER) executable.file_base;
1475 if (dos_header->e_magic != IMAGE_DOS_SIGNATURE)
1476 goto unwind;
1477
1478 nt_header = (PIMAGE_NT_HEADERS) ((unsigned char *) dos_header + dos_header->e_lfanew);
1479
1480 if ((char *) nt_header > (char *) dos_header + executable.size)
1481 {
1482 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1483 *is_dos_app = TRUE;
1484 }
1485 else if (nt_header->Signature != IMAGE_NT_SIGNATURE
1486 && LOWORD (nt_header->Signature) != IMAGE_OS2_SIGNATURE)
1487 {
1488 *is_dos_app = TRUE;
1489 }
1490 else if (nt_header->Signature == IMAGE_NT_SIGNATURE)
1491 {
1492 IMAGE_DATA_DIRECTORY *data_dir = NULL;
1493 if (nt_header->OptionalHeader.Magic == IMAGE_NT_OPTIONAL_HDR32_MAGIC)
1494 {
1495 /* Ensure we are using the 32 bit structure. */
1496 IMAGE_OPTIONAL_HEADER32 *opt
1497 = (IMAGE_OPTIONAL_HEADER32*) &(nt_header->OptionalHeader);
1498 data_dir = opt->DataDirectory;
1499 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1500 }
1501 /* MingW 3.12 has the required 64 bit structs, but in case older
1502 versions don't, only check 64 bit exes if we know how. */
1503 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1504 else if (nt_header->OptionalHeader.Magic
1505 == IMAGE_NT_OPTIONAL_HDR64_MAGIC)
1506 {
1507 IMAGE_OPTIONAL_HEADER64 *opt
1508 = (IMAGE_OPTIONAL_HEADER64*) &(nt_header->OptionalHeader);
1509 data_dir = opt->DataDirectory;
1510 *is_gui_app = (opt->Subsystem == IMAGE_SUBSYSTEM_WINDOWS_GUI);
1511 }
1512 #endif
1513 if (data_dir)
1514 {
1515 /* Look for cygwin.dll in DLL import list. */
1516 IMAGE_DATA_DIRECTORY import_dir =
1517 data_dir[IMAGE_DIRECTORY_ENTRY_IMPORT];
1518 IMAGE_IMPORT_DESCRIPTOR * imports;
1519 IMAGE_SECTION_HEADER * section;
1520
1521 section = rva_to_section (import_dir.VirtualAddress, nt_header);
1522 imports = RVA_TO_PTR (import_dir.VirtualAddress, section,
1523 executable);
1524
1525 for ( ; imports->Name; imports++)
1526 {
1527 char * dllname = RVA_TO_PTR (imports->Name, section,
1528 executable);
1529
1530 /* The exact name of the cygwin dll has changed with
1531 various releases, but hopefully this will be reasonably
1532 future proof. */
1533 if (strncmp (dllname, "cygwin", 6) == 0)
1534 {
1535 *is_cygnus_app = TRUE;
1536 break;
1537 }
1538 }
1539 }
1540 }
1541 }
1542
1543 unwind:
1544 close_file_data (&executable);
1545 }
1546
1547 static int
1548 compare_env (const void *strp1, const void *strp2)
1549 {
1550 const char *str1 = *(const char **)strp1, *str2 = *(const char **)strp2;
1551
1552 while (*str1 && *str2 && *str1 != '=' && *str2 != '=')
1553 {
1554 /* Sort order in command.com/cmd.exe is based on uppercasing
1555 names, so do the same here. */
1556 if (toupper (*str1) > toupper (*str2))
1557 return 1;
1558 else if (toupper (*str1) < toupper (*str2))
1559 return -1;
1560 str1++, str2++;
1561 }
1562
1563 if (*str1 == '=' && *str2 == '=')
1564 return 0;
1565 else if (*str1 == '=')
1566 return -1;
1567 else
1568 return 1;
1569 }
1570
1571 static void
1572 merge_and_sort_env (char **envp1, char **envp2, char **new_envp)
1573 {
1574 char **optr, **nptr;
1575 int num;
1576
1577 nptr = new_envp;
1578 optr = envp1;
1579 while (*optr)
1580 *nptr++ = *optr++;
1581 num = optr - envp1;
1582
1583 optr = envp2;
1584 while (*optr)
1585 *nptr++ = *optr++;
1586 num += optr - envp2;
1587
1588 qsort (new_envp, num, sizeof (char *), compare_env);
1589
1590 *nptr = NULL;
1591 }
1592
1593 /* When a new child process is created we need to register it in our list,
1594 so intercept spawn requests. */
1595 int
1596 sys_spawnve (int mode, char *cmdname, char **argv, char **envp)
1597 {
1598 Lisp_Object program, full;
1599 char *cmdline, *env, *parg, **targ;
1600 int arglen, numenv;
1601 pid_t pid;
1602 child_process *cp;
1603 int is_dos_app, is_cygnus_app, is_gui_app;
1604 int do_quoting = 0;
1605 /* We pass our process ID to our children by setting up an environment
1606 variable in their environment. */
1607 char ppid_env_var_buffer[64];
1608 char *extra_env[] = {ppid_env_var_buffer, NULL};
1609 /* These are the characters that cause an argument to need quoting.
1610 Arguments with whitespace characters need quoting to prevent the
1611 argument being split into two or more. Arguments with wildcards
1612 are also quoted, for consistency with posix platforms, where wildcards
1613 are not expanded if we run the program directly without a shell.
1614 Some extra whitespace characters need quoting in Cygwin programs,
1615 so this list is conditionally modified below. */
1616 char *sepchars = " \t*?";
1617 /* This is for native w32 apps; modified below for Cygwin apps. */
1618 char escape_char = '\\';
1619
1620 /* We don't care about the other modes */
1621 if (mode != _P_NOWAIT)
1622 {
1623 errno = EINVAL;
1624 return -1;
1625 }
1626
1627 /* Handle executable names without an executable suffix. */
1628 program = build_string (cmdname);
1629 if (NILP (Ffile_executable_p (program)))
1630 {
1631 struct gcpro gcpro1;
1632
1633 full = Qnil;
1634 GCPRO1 (program);
1635 openp (Vexec_path, program, Vexec_suffixes, &full, make_number (X_OK));
1636 UNGCPRO;
1637 if (NILP (full))
1638 {
1639 errno = EINVAL;
1640 return -1;
1641 }
1642 program = full;
1643 }
1644
1645 /* make sure argv[0] and cmdname are both in DOS format */
1646 cmdname = SDATA (program);
1647 unixtodos_filename (cmdname);
1648 argv[0] = cmdname;
1649
1650 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1651 executable that is implicitly linked to the Cygnus dll (implying it
1652 was compiled with the Cygnus GNU toolchain and hence relies on
1653 cygwin.dll to parse the command line - we use this to decide how to
1654 escape quote chars in command line args that must be quoted).
1655
1656 Also determine whether it is a GUI app, so that we don't hide its
1657 initial window unless specifically requested. */
1658 w32_executable_type (cmdname, &is_dos_app, &is_cygnus_app, &is_gui_app);
1659
1660 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1661 application to start it by specifying the helper app as cmdname,
1662 while leaving the real app name as argv[0]. */
1663 if (is_dos_app)
1664 {
1665 cmdname = alloca (MAXPATHLEN);
1666 if (egetenv ("CMDPROXY"))
1667 strcpy (cmdname, egetenv ("CMDPROXY"));
1668 else
1669 {
1670 strcpy (cmdname, SDATA (Vinvocation_directory));
1671 strcat (cmdname, "cmdproxy.exe");
1672 }
1673 unixtodos_filename (cmdname);
1674 }
1675
1676 /* we have to do some conjuring here to put argv and envp into the
1677 form CreateProcess wants... argv needs to be a space separated/null
1678 terminated list of parameters, and envp is a null
1679 separated/double-null terminated list of parameters.
1680
1681 Additionally, zero-length args and args containing whitespace or
1682 quote chars need to be wrapped in double quotes - for this to work,
1683 embedded quotes need to be escaped as well. The aim is to ensure
1684 the child process reconstructs the argv array we start with
1685 exactly, so we treat quotes at the beginning and end of arguments
1686 as embedded quotes.
1687
1688 The w32 GNU-based library from Cygnus doubles quotes to escape
1689 them, while MSVC uses backslash for escaping. (Actually the MSVC
1690 startup code does attempt to recognize doubled quotes and accept
1691 them, but gets it wrong and ends up requiring three quotes to get a
1692 single embedded quote!) So by default we decide whether to use
1693 quote or backslash as the escape character based on whether the
1694 binary is apparently a Cygnus compiled app.
1695
1696 Note that using backslash to escape embedded quotes requires
1697 additional special handling if an embedded quote is already
1698 preceded by backslash, or if an arg requiring quoting ends with
1699 backslash. In such cases, the run of escape characters needs to be
1700 doubled. For consistency, we apply this special handling as long
1701 as the escape character is not quote.
1702
1703 Since we have no idea how large argv and envp are likely to be we
1704 figure out list lengths on the fly and allocate them. */
1705
1706 if (!NILP (Vw32_quote_process_args))
1707 {
1708 do_quoting = 1;
1709 /* Override escape char by binding w32-quote-process-args to
1710 desired character, or use t for auto-selection. */
1711 if (INTEGERP (Vw32_quote_process_args))
1712 escape_char = XINT (Vw32_quote_process_args);
1713 else
1714 escape_char = is_cygnus_app ? '"' : '\\';
1715 }
1716
1717 /* Cygwin apps needs quoting a bit more often. */
1718 if (escape_char == '"')
1719 sepchars = "\r\n\t\f '";
1720
1721 /* do argv... */
1722 arglen = 0;
1723 targ = argv;
1724 while (*targ)
1725 {
1726 char * p = *targ;
1727 int need_quotes = 0;
1728 int escape_char_run = 0;
1729
1730 if (*p == 0)
1731 need_quotes = 1;
1732 for ( ; *p; p++)
1733 {
1734 if (escape_char == '"' && *p == '\\')
1735 /* If it's a Cygwin app, \ needs to be escaped. */
1736 arglen++;
1737 else if (*p == '"')
1738 {
1739 /* allow for embedded quotes to be escaped */
1740 arglen++;
1741 need_quotes = 1;
1742 /* handle the case where the embedded quote is already escaped */
1743 if (escape_char_run > 0)
1744 {
1745 /* To preserve the arg exactly, we need to double the
1746 preceding escape characters (plus adding one to
1747 escape the quote character itself). */
1748 arglen += escape_char_run;
1749 }
1750 }
1751 else if (strchr (sepchars, *p) != NULL)
1752 {
1753 need_quotes = 1;
1754 }
1755
1756 if (*p == escape_char && escape_char != '"')
1757 escape_char_run++;
1758 else
1759 escape_char_run = 0;
1760 }
1761 if (need_quotes)
1762 {
1763 arglen += 2;
1764 /* handle the case where the arg ends with an escape char - we
1765 must not let the enclosing quote be escaped. */
1766 if (escape_char_run > 0)
1767 arglen += escape_char_run;
1768 }
1769 arglen += strlen (*targ++) + 1;
1770 }
1771 cmdline = alloca (arglen);
1772 targ = argv;
1773 parg = cmdline;
1774 while (*targ)
1775 {
1776 char * p = *targ;
1777 int need_quotes = 0;
1778
1779 if (*p == 0)
1780 need_quotes = 1;
1781
1782 if (do_quoting)
1783 {
1784 for ( ; *p; p++)
1785 if ((strchr (sepchars, *p) != NULL) || *p == '"')
1786 need_quotes = 1;
1787 }
1788 if (need_quotes)
1789 {
1790 int escape_char_run = 0;
1791 char * first;
1792 char * last;
1793
1794 p = *targ;
1795 first = p;
1796 last = p + strlen (p) - 1;
1797 *parg++ = '"';
1798 #if 0
1799 /* This version does not escape quotes if they occur at the
1800 beginning or end of the arg - this could lead to incorrect
1801 behavior when the arg itself represents a command line
1802 containing quoted args. I believe this was originally done
1803 as a hack to make some things work, before
1804 `w32-quote-process-args' was added. */
1805 while (*p)
1806 {
1807 if (*p == '"' && p > first && p < last)
1808 *parg++ = escape_char; /* escape embedded quotes */
1809 *parg++ = *p++;
1810 }
1811 #else
1812 for ( ; *p; p++)
1813 {
1814 if (*p == '"')
1815 {
1816 /* double preceding escape chars if any */
1817 while (escape_char_run > 0)
1818 {
1819 *parg++ = escape_char;
1820 escape_char_run--;
1821 }
1822 /* escape all quote chars, even at beginning or end */
1823 *parg++ = escape_char;
1824 }
1825 else if (escape_char == '"' && *p == '\\')
1826 *parg++ = '\\';
1827 *parg++ = *p;
1828
1829 if (*p == escape_char && escape_char != '"')
1830 escape_char_run++;
1831 else
1832 escape_char_run = 0;
1833 }
1834 /* double escape chars before enclosing quote */
1835 while (escape_char_run > 0)
1836 {
1837 *parg++ = escape_char;
1838 escape_char_run--;
1839 }
1840 #endif
1841 *parg++ = '"';
1842 }
1843 else
1844 {
1845 strcpy (parg, *targ);
1846 parg += strlen (*targ);
1847 }
1848 *parg++ = ' ';
1849 targ++;
1850 }
1851 *--parg = '\0';
1852
1853 /* and envp... */
1854 arglen = 1;
1855 targ = envp;
1856 numenv = 1; /* for end null */
1857 while (*targ)
1858 {
1859 arglen += strlen (*targ++) + 1;
1860 numenv++;
1861 }
1862 /* extra env vars... */
1863 sprintf (ppid_env_var_buffer, "EM_PARENT_PROCESS_ID=%lu",
1864 GetCurrentProcessId ());
1865 arglen += strlen (ppid_env_var_buffer) + 1;
1866 numenv++;
1867
1868 /* merge env passed in and extra env into one, and sort it. */
1869 targ = (char **) alloca (numenv * sizeof (char *));
1870 merge_and_sort_env (envp, extra_env, targ);
1871
1872 /* concatenate env entries. */
1873 env = alloca (arglen);
1874 parg = env;
1875 while (*targ)
1876 {
1877 strcpy (parg, *targ);
1878 parg += strlen (*targ++);
1879 *parg++ = '\0';
1880 }
1881 *parg++ = '\0';
1882 *parg = '\0';
1883
1884 cp = new_child ();
1885 if (cp == NULL)
1886 {
1887 errno = EAGAIN;
1888 return -1;
1889 }
1890
1891 /* Now create the process. */
1892 if (!create_child (cmdname, cmdline, env, is_gui_app, &pid, cp))
1893 {
1894 delete_child (cp);
1895 errno = ENOEXEC;
1896 return -1;
1897 }
1898
1899 return pid;
1900 }
1901
1902 /* Emulate the select call
1903 Wait for available input on any of the given rfds, or timeout if
1904 a timeout is given and no input is detected
1905 wfds and efds are not supported and must be NULL.
1906
1907 For simplicity, we detect the death of child processes here and
1908 synchronously call the SIGCHLD handler. Since it is possible for
1909 children to be created without a corresponding pipe handle from which
1910 to read output, we wait separately on the process handles as well as
1911 the char_avail events for each process pipe. We only call
1912 wait/reap_process when the process actually terminates.
1913
1914 To reduce the number of places in which Emacs can be hung such that
1915 C-g is not able to interrupt it, we always wait on interrupt_handle
1916 (which is signaled by the input thread when C-g is detected). If we
1917 detect that we were woken up by C-g, we return -1 with errno set to
1918 EINTR as on Unix. */
1919
1920 /* From w32console.c */
1921 extern HANDLE keyboard_handle;
1922
1923 /* From w32xfns.c */
1924 extern HANDLE interrupt_handle;
1925
1926 /* From process.c */
1927 extern int proc_buffered_char[];
1928
1929 int
1930 sys_select (int nfds, SELECT_TYPE *rfds, SELECT_TYPE *wfds, SELECT_TYPE *efds,
1931 struct timespec *timeout, void *ignored)
1932 {
1933 SELECT_TYPE orfds;
1934 DWORD timeout_ms, start_time;
1935 int i, nh, nc, nr;
1936 DWORD active;
1937 child_process *cp, *cps[MAX_CHILDREN];
1938 HANDLE wait_hnd[MAXDESC + MAX_CHILDREN];
1939 int fdindex[MAXDESC]; /* mapping from wait handles back to descriptors */
1940
1941 timeout_ms =
1942 timeout ? (timeout->tv_sec * 1000 + timeout->tv_nsec / 1000000) : INFINITE;
1943
1944 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1945 if (rfds == NULL && wfds == NULL && efds == NULL && timeout != NULL)
1946 {
1947 Sleep (timeout_ms);
1948 return 0;
1949 }
1950
1951 /* Otherwise, we only handle rfds, so fail otherwise. */
1952 if (rfds == NULL || wfds != NULL || efds != NULL)
1953 {
1954 errno = EINVAL;
1955 return -1;
1956 }
1957
1958 orfds = *rfds;
1959 FD_ZERO (rfds);
1960 nr = 0;
1961
1962 /* Always wait on interrupt_handle, to detect C-g (quit). */
1963 wait_hnd[0] = interrupt_handle;
1964 fdindex[0] = -1;
1965
1966 /* Build a list of pipe handles to wait on. */
1967 nh = 1;
1968 for (i = 0; i < nfds; i++)
1969 if (FD_ISSET (i, &orfds))
1970 {
1971 if (i == 0)
1972 {
1973 if (keyboard_handle)
1974 {
1975 /* Handle stdin specially */
1976 wait_hnd[nh] = keyboard_handle;
1977 fdindex[nh] = i;
1978 nh++;
1979 }
1980
1981 /* Check for any emacs-generated input in the queue since
1982 it won't be detected in the wait */
1983 if (detect_input_pending ())
1984 {
1985 FD_SET (i, rfds);
1986 return 1;
1987 }
1988 }
1989 else
1990 {
1991 /* Child process and socket/comm port input. */
1992 cp = fd_info[i].cp;
1993 if (cp)
1994 {
1995 int current_status = cp->status;
1996
1997 if (current_status == STATUS_READ_ACKNOWLEDGED)
1998 {
1999 /* Tell reader thread which file handle to use. */
2000 cp->fd = i;
2001 /* Wake up the reader thread for this process */
2002 cp->status = STATUS_READ_READY;
2003 if (!SetEvent (cp->char_consumed))
2004 DebPrint (("sys_select.SetEvent failed with "
2005 "%lu for fd %ld\n", GetLastError (), i));
2006 }
2007
2008 #ifdef CHECK_INTERLOCK
2009 /* slightly crude cross-checking of interlock between threads */
2010
2011 current_status = cp->status;
2012 if (WaitForSingleObject (cp->char_avail, 0) == WAIT_OBJECT_0)
2013 {
2014 /* char_avail has been signaled, so status (which may
2015 have changed) should indicate read has completed
2016 but has not been acknowledged. */
2017 current_status = cp->status;
2018 if (current_status != STATUS_READ_SUCCEEDED
2019 && current_status != STATUS_READ_FAILED)
2020 DebPrint (("char_avail set, but read not completed: status %d\n",
2021 current_status));
2022 }
2023 else
2024 {
2025 /* char_avail has not been signaled, so status should
2026 indicate that read is in progress; small possibility
2027 that read has completed but event wasn't yet signaled
2028 when we tested it (because a context switch occurred
2029 or if running on separate CPUs). */
2030 if (current_status != STATUS_READ_READY
2031 && current_status != STATUS_READ_IN_PROGRESS
2032 && current_status != STATUS_READ_SUCCEEDED
2033 && current_status != STATUS_READ_FAILED)
2034 DebPrint (("char_avail reset, but read status is bad: %d\n",
2035 current_status));
2036 }
2037 #endif
2038 wait_hnd[nh] = cp->char_avail;
2039 fdindex[nh] = i;
2040 if (!wait_hnd[nh]) emacs_abort ();
2041 nh++;
2042 #ifdef FULL_DEBUG
2043 DebPrint (("select waiting on child %d fd %d\n",
2044 cp-child_procs, i));
2045 #endif
2046 }
2047 else
2048 {
2049 /* Unable to find something to wait on for this fd, skip */
2050
2051 /* Note that this is not a fatal error, and can in fact
2052 happen in unusual circumstances. Specifically, if
2053 sys_spawnve fails, eg. because the program doesn't
2054 exist, and debug-on-error is t so Fsignal invokes a
2055 nested input loop, then the process output pipe is
2056 still included in input_wait_mask with no child_proc
2057 associated with it. (It is removed when the debugger
2058 exits the nested input loop and the error is thrown.) */
2059
2060 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i));
2061 }
2062 }
2063 }
2064
2065 count_children:
2066 /* Add handles of child processes. */
2067 nc = 0;
2068 for (cp = child_procs + (child_proc_count-1); cp >= child_procs; cp--)
2069 /* Some child_procs might be sockets; ignore them. Also some
2070 children may have died already, but we haven't finished reading
2071 the process output; ignore them too. */
2072 if ((CHILD_ACTIVE (cp) && cp->procinfo.hProcess)
2073 && (cp->fd < 0
2074 || (fd_info[cp->fd].flags & FILE_SEND_SIGCHLD) == 0
2075 || (fd_info[cp->fd].flags & FILE_AT_EOF) != 0)
2076 )
2077 {
2078 wait_hnd[nh + nc] = cp->procinfo.hProcess;
2079 cps[nc] = cp;
2080 nc++;
2081 }
2082
2083 /* Nothing to look for, so we didn't find anything */
2084 if (nh + nc == 0)
2085 {
2086 if (timeout)
2087 Sleep (timeout_ms);
2088 return 0;
2089 }
2090
2091 start_time = GetTickCount ();
2092
2093 /* Wait for input or child death to be signaled. If user input is
2094 allowed, then also accept window messages. */
2095 if (FD_ISSET (0, &orfds))
2096 active = MsgWaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms,
2097 QS_ALLINPUT);
2098 else
2099 active = WaitForMultipleObjects (nh + nc, wait_hnd, FALSE, timeout_ms);
2100
2101 if (active == WAIT_FAILED)
2102 {
2103 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2104 nh + nc, timeout_ms, GetLastError ()));
2105 /* don't return EBADF - this causes wait_reading_process_output to
2106 abort; WAIT_FAILED is returned when single-stepping under
2107 Windows 95 after switching thread focus in debugger, and
2108 possibly at other times. */
2109 errno = EINTR;
2110 return -1;
2111 }
2112 else if (active == WAIT_TIMEOUT)
2113 {
2114 return 0;
2115 }
2116 else if (active >= WAIT_OBJECT_0
2117 && active < WAIT_OBJECT_0+MAXIMUM_WAIT_OBJECTS)
2118 {
2119 active -= WAIT_OBJECT_0;
2120 }
2121 else if (active >= WAIT_ABANDONED_0
2122 && active < WAIT_ABANDONED_0+MAXIMUM_WAIT_OBJECTS)
2123 {
2124 active -= WAIT_ABANDONED_0;
2125 }
2126 else
2127 emacs_abort ();
2128
2129 /* Loop over all handles after active (now officially documented as
2130 being the first signaled handle in the array). We do this to
2131 ensure fairness, so that all channels with data available will be
2132 processed - otherwise higher numbered channels could be starved. */
2133 do
2134 {
2135 if (active == nh + nc)
2136 {
2137 /* There are messages in the lisp thread's queue; we must
2138 drain the queue now to ensure they are processed promptly,
2139 because if we don't do so, we will not be woken again until
2140 further messages arrive.
2141
2142 NB. If ever we allow window message procedures to callback
2143 into lisp, we will need to ensure messages are dispatched
2144 at a safe time for lisp code to be run (*), and we may also
2145 want to provide some hooks in the dispatch loop to cater
2146 for modeless dialogs created by lisp (ie. to register
2147 window handles to pass to IsDialogMessage).
2148
2149 (*) Note that MsgWaitForMultipleObjects above is an
2150 internal dispatch point for messages that are sent to
2151 windows created by this thread. */
2152 if (drain_message_queue ()
2153 /* If drain_message_queue returns non-zero, that means
2154 we received a WM_EMACS_FILENOTIFY message. If this
2155 is a TTY frame, we must signal the caller that keyboard
2156 input is available, so that w32_console_read_socket
2157 will be called to pick up the notifications. If we
2158 don't do that, file notifications will only work when
2159 the Emacs TTY frame has focus. */
2160 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2161 /* they asked for stdin reads */
2162 && FD_ISSET (0, &orfds)
2163 /* the stdin handle is valid */
2164 && keyboard_handle)
2165 {
2166 FD_SET (0, rfds);
2167 if (nr == 0)
2168 nr = 1;
2169 }
2170 }
2171 else if (active >= nh)
2172 {
2173 cp = cps[active - nh];
2174
2175 /* We cannot always signal SIGCHLD immediately; if we have not
2176 finished reading the process output, we must delay sending
2177 SIGCHLD until we do. */
2178
2179 if (cp->fd >= 0 && (fd_info[cp->fd].flags & FILE_AT_EOF) == 0)
2180 fd_info[cp->fd].flags |= FILE_SEND_SIGCHLD;
2181 /* SIG_DFL for SIGCHLD is ignore */
2182 else if (sig_handlers[SIGCHLD] != SIG_DFL &&
2183 sig_handlers[SIGCHLD] != SIG_IGN)
2184 {
2185 #ifdef FULL_DEBUG
2186 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2187 cp->pid));
2188 #endif
2189 sig_handlers[SIGCHLD] (SIGCHLD);
2190 }
2191 }
2192 else if (fdindex[active] == -1)
2193 {
2194 /* Quit (C-g) was detected. */
2195 errno = EINTR;
2196 return -1;
2197 }
2198 else if (fdindex[active] == 0)
2199 {
2200 /* Keyboard input available */
2201 FD_SET (0, rfds);
2202 nr++;
2203 }
2204 else
2205 {
2206 /* must be a socket or pipe - read ahead should have
2207 completed, either succeeding or failing. */
2208 FD_SET (fdindex[active], rfds);
2209 nr++;
2210 }
2211
2212 /* Even though wait_reading_process_output only reads from at most
2213 one channel, we must process all channels here so that we reap
2214 all children that have died. */
2215 while (++active < nh + nc)
2216 if (WaitForSingleObject (wait_hnd[active], 0) == WAIT_OBJECT_0)
2217 break;
2218 } while (active < nh + nc);
2219
2220 /* If no input has arrived and timeout hasn't expired, wait again. */
2221 if (nr == 0)
2222 {
2223 DWORD elapsed = GetTickCount () - start_time;
2224
2225 if (timeout_ms > elapsed) /* INFINITE is MAX_UINT */
2226 {
2227 if (timeout_ms != INFINITE)
2228 timeout_ms -= elapsed;
2229 goto count_children;
2230 }
2231 }
2232
2233 return nr;
2234 }
2235
2236 /* Substitute for certain kill () operations */
2237
2238 static BOOL CALLBACK
2239 find_child_console (HWND hwnd, LPARAM arg)
2240 {
2241 child_process * cp = (child_process *) arg;
2242 DWORD thread_id;
2243 DWORD process_id;
2244
2245 thread_id = GetWindowThreadProcessId (hwnd, &process_id);
2246 if (process_id == cp->procinfo.dwProcessId)
2247 {
2248 char window_class[32];
2249
2250 GetClassName (hwnd, window_class, sizeof (window_class));
2251 if (strcmp (window_class,
2252 (os_subtype == OS_9X)
2253 ? "tty"
2254 : "ConsoleWindowClass") == 0)
2255 {
2256 cp->hwnd = hwnd;
2257 return FALSE;
2258 }
2259 }
2260 /* keep looking */
2261 return TRUE;
2262 }
2263
2264 /* Emulate 'kill', but only for other processes. */
2265 int
2266 sys_kill (pid_t pid, int sig)
2267 {
2268 child_process *cp;
2269 HANDLE proc_hand;
2270 int need_to_free = 0;
2271 int rc = 0;
2272
2273 /* Each process is in its own process group. */
2274 if (pid < 0)
2275 pid = -pid;
2276
2277 /* Only handle signals that will result in the process dying */
2278 if (sig != 0
2279 && sig != SIGINT && sig != SIGKILL && sig != SIGQUIT && sig != SIGHUP)
2280 {
2281 errno = EINVAL;
2282 return -1;
2283 }
2284
2285 if (sig == 0)
2286 {
2287 /* It will take _some_ time before PID 4 or less on Windows will
2288 be Emacs... */
2289 if (pid <= 4)
2290 {
2291 errno = EPERM;
2292 return -1;
2293 }
2294 proc_hand = OpenProcess (PROCESS_QUERY_INFORMATION, 0, pid);
2295 if (proc_hand == NULL)
2296 {
2297 DWORD err = GetLastError ();
2298
2299 switch (err)
2300 {
2301 case ERROR_ACCESS_DENIED: /* existing process, but access denied */
2302 errno = EPERM;
2303 return -1;
2304 case ERROR_INVALID_PARAMETER: /* process PID does not exist */
2305 errno = ESRCH;
2306 return -1;
2307 }
2308 }
2309 else
2310 CloseHandle (proc_hand);
2311 return 0;
2312 }
2313
2314 cp = find_child_pid (pid);
2315 if (cp == NULL)
2316 {
2317 /* We were passed a PID of something other than our subprocess.
2318 If that is our own PID, we will send to ourself a message to
2319 close the selected frame, which does not necessarily
2320 terminates Emacs. But then we are not supposed to call
2321 sys_kill with our own PID. */
2322 proc_hand = OpenProcess (PROCESS_TERMINATE, 0, pid);
2323 if (proc_hand == NULL)
2324 {
2325 errno = EPERM;
2326 return -1;
2327 }
2328 need_to_free = 1;
2329 }
2330 else
2331 {
2332 proc_hand = cp->procinfo.hProcess;
2333 pid = cp->procinfo.dwProcessId;
2334
2335 /* Try to locate console window for process. */
2336 EnumWindows (find_child_console, (LPARAM) cp);
2337 }
2338
2339 if (sig == SIGINT || sig == SIGQUIT)
2340 {
2341 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2342 {
2343 BYTE control_scan_code = (BYTE) MapVirtualKey (VK_CONTROL, 0);
2344 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2345 BYTE vk_break_code = (sig == SIGINT) ? 'C' : VK_CANCEL;
2346 BYTE break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2347 HWND foreground_window;
2348
2349 if (break_scan_code == 0)
2350 {
2351 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2352 vk_break_code = 'C';
2353 break_scan_code = (BYTE) MapVirtualKey (vk_break_code, 0);
2354 }
2355
2356 foreground_window = GetForegroundWindow ();
2357 if (foreground_window)
2358 {
2359 /* NT 5.0, and apparently also Windows 98, will not allow
2360 a Window to be set to foreground directly without the
2361 user's involvement. The workaround is to attach
2362 ourselves to the thread that owns the foreground
2363 window, since that is the only thread that can set the
2364 foreground window. */
2365 DWORD foreground_thread, child_thread;
2366 foreground_thread =
2367 GetWindowThreadProcessId (foreground_window, NULL);
2368 if (foreground_thread == GetCurrentThreadId ()
2369 || !AttachThreadInput (GetCurrentThreadId (),
2370 foreground_thread, TRUE))
2371 foreground_thread = 0;
2372
2373 child_thread = GetWindowThreadProcessId (cp->hwnd, NULL);
2374 if (child_thread == GetCurrentThreadId ()
2375 || !AttachThreadInput (GetCurrentThreadId (),
2376 child_thread, TRUE))
2377 child_thread = 0;
2378
2379 /* Set the foreground window to the child. */
2380 if (SetForegroundWindow (cp->hwnd))
2381 {
2382 /* Generate keystrokes as if user had typed Ctrl-Break or
2383 Ctrl-C. */
2384 keybd_event (VK_CONTROL, control_scan_code, 0, 0);
2385 keybd_event (vk_break_code, break_scan_code,
2386 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY), 0);
2387 keybd_event (vk_break_code, break_scan_code,
2388 (vk_break_code == 'C' ? 0 : KEYEVENTF_EXTENDEDKEY)
2389 | KEYEVENTF_KEYUP, 0);
2390 keybd_event (VK_CONTROL, control_scan_code,
2391 KEYEVENTF_KEYUP, 0);
2392
2393 /* Sleep for a bit to give time for Emacs frame to respond
2394 to focus change events (if Emacs was active app). */
2395 Sleep (100);
2396
2397 SetForegroundWindow (foreground_window);
2398 }
2399 /* Detach from the foreground and child threads now that
2400 the foreground switching is over. */
2401 if (foreground_thread)
2402 AttachThreadInput (GetCurrentThreadId (),
2403 foreground_thread, FALSE);
2404 if (child_thread)
2405 AttachThreadInput (GetCurrentThreadId (),
2406 child_thread, FALSE);
2407 }
2408 }
2409 /* Ctrl-Break is NT equivalent of SIGINT. */
2410 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT, pid))
2411 {
2412 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2413 "for pid %lu\n", GetLastError (), pid));
2414 errno = EINVAL;
2415 rc = -1;
2416 }
2417 }
2418 else
2419 {
2420 if (NILP (Vw32_start_process_share_console) && cp && cp->hwnd)
2421 {
2422 #if 1
2423 if (os_subtype == OS_9X)
2424 {
2425 /*
2426 Another possibility is to try terminating the VDM out-right by
2427 calling the Shell VxD (id 0x17) V86 interface, function #4
2428 "SHELL_Destroy_VM", ie.
2429
2430 mov edx,4
2431 mov ebx,vm_handle
2432 call shellapi
2433
2434 First need to determine the current VM handle, and then arrange for
2435 the shellapi call to be made from the system vm (by using
2436 Switch_VM_and_callback).
2437
2438 Could try to invoke DestroyVM through CallVxD.
2439
2440 */
2441 #if 0
2442 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2443 to hang when cmdproxy is used in conjunction with
2444 command.com for an interactive shell. Posting
2445 WM_CLOSE pops up a dialog that, when Yes is selected,
2446 does the same thing. TerminateProcess is also less
2447 than ideal in that subprocesses tend to stick around
2448 until the machine is shutdown, but at least it
2449 doesn't freeze the 16-bit subsystem. */
2450 PostMessage (cp->hwnd, WM_QUIT, 0xff, 0);
2451 #endif
2452 if (!TerminateProcess (proc_hand, 0xff))
2453 {
2454 DebPrint (("sys_kill.TerminateProcess returned %d "
2455 "for pid %lu\n", GetLastError (), pid));
2456 errno = EINVAL;
2457 rc = -1;
2458 }
2459 }
2460 else
2461 #endif
2462 PostMessage (cp->hwnd, WM_CLOSE, 0, 0);
2463 }
2464 /* Kill the process. On W32 this doesn't kill child processes
2465 so it doesn't work very well for shells which is why it's not
2466 used in every case. */
2467 else if (!TerminateProcess (proc_hand, 0xff))
2468 {
2469 DebPrint (("sys_kill.TerminateProcess returned %d "
2470 "for pid %lu\n", GetLastError (), pid));
2471 errno = EINVAL;
2472 rc = -1;
2473 }
2474 }
2475
2476 if (need_to_free)
2477 CloseHandle (proc_hand);
2478
2479 return rc;
2480 }
2481
2482 /* The following two routines are used to manipulate stdin, stdout, and
2483 stderr of our child processes.
2484
2485 Assuming that in, out, and err are *not* inheritable, we make them
2486 stdin, stdout, and stderr of the child as follows:
2487
2488 - Save the parent's current standard handles.
2489 - Set the std handles to inheritable duplicates of the ones being passed in.
2490 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2491 NT file handle for a crt file descriptor.)
2492 - Spawn the child, which inherits in, out, and err as stdin,
2493 stdout, and stderr. (see Spawnve)
2494 - Close the std handles passed to the child.
2495 - Reset the parent's standard handles to the saved handles.
2496 (see reset_standard_handles)
2497 We assume that the caller closes in, out, and err after calling us. */
2498
2499 void
2500 prepare_standard_handles (int in, int out, int err, HANDLE handles[3])
2501 {
2502 HANDLE parent;
2503 HANDLE newstdin, newstdout, newstderr;
2504
2505 parent = GetCurrentProcess ();
2506
2507 handles[0] = GetStdHandle (STD_INPUT_HANDLE);
2508 handles[1] = GetStdHandle (STD_OUTPUT_HANDLE);
2509 handles[2] = GetStdHandle (STD_ERROR_HANDLE);
2510
2511 /* make inheritable copies of the new handles */
2512 if (!DuplicateHandle (parent,
2513 (HANDLE) _get_osfhandle (in),
2514 parent,
2515 &newstdin,
2516 0,
2517 TRUE,
2518 DUPLICATE_SAME_ACCESS))
2519 report_file_error ("Duplicating input handle for child", Qnil);
2520
2521 if (!DuplicateHandle (parent,
2522 (HANDLE) _get_osfhandle (out),
2523 parent,
2524 &newstdout,
2525 0,
2526 TRUE,
2527 DUPLICATE_SAME_ACCESS))
2528 report_file_error ("Duplicating output handle for child", Qnil);
2529
2530 if (!DuplicateHandle (parent,
2531 (HANDLE) _get_osfhandle (err),
2532 parent,
2533 &newstderr,
2534 0,
2535 TRUE,
2536 DUPLICATE_SAME_ACCESS))
2537 report_file_error ("Duplicating error handle for child", Qnil);
2538
2539 /* and store them as our std handles */
2540 if (!SetStdHandle (STD_INPUT_HANDLE, newstdin))
2541 report_file_error ("Changing stdin handle", Qnil);
2542
2543 if (!SetStdHandle (STD_OUTPUT_HANDLE, newstdout))
2544 report_file_error ("Changing stdout handle", Qnil);
2545
2546 if (!SetStdHandle (STD_ERROR_HANDLE, newstderr))
2547 report_file_error ("Changing stderr handle", Qnil);
2548 }
2549
2550 void
2551 reset_standard_handles (int in, int out, int err, HANDLE handles[3])
2552 {
2553 /* close the duplicated handles passed to the child */
2554 CloseHandle (GetStdHandle (STD_INPUT_HANDLE));
2555 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE));
2556 CloseHandle (GetStdHandle (STD_ERROR_HANDLE));
2557
2558 /* now restore parent's saved std handles */
2559 SetStdHandle (STD_INPUT_HANDLE, handles[0]);
2560 SetStdHandle (STD_OUTPUT_HANDLE, handles[1]);
2561 SetStdHandle (STD_ERROR_HANDLE, handles[2]);
2562 }
2563
2564 void
2565 set_process_dir (char * dir)
2566 {
2567 process_dir = dir;
2568 }
2569
2570 /* To avoid problems with winsock implementations that work over dial-up
2571 connections causing or requiring a connection to exist while Emacs is
2572 running, Emacs no longer automatically loads winsock on startup if it
2573 is present. Instead, it will be loaded when open-network-stream is
2574 first called.
2575
2576 To allow full control over when winsock is loaded, we provide these
2577 two functions to dynamically load and unload winsock. This allows
2578 dial-up users to only be connected when they actually need to use
2579 socket services. */
2580
2581 /* From w32.c */
2582 extern HANDLE winsock_lib;
2583 extern BOOL term_winsock (void);
2584 extern BOOL init_winsock (int load_now);
2585
2586 DEFUN ("w32-has-winsock", Fw32_has_winsock, Sw32_has_winsock, 0, 1, 0,
2587 doc: /* Test for presence of the Windows socket library `winsock'.
2588 Returns non-nil if winsock support is present, nil otherwise.
2589
2590 If the optional argument LOAD-NOW is non-nil, the winsock library is
2591 also loaded immediately if not already loaded. If winsock is loaded,
2592 the winsock local hostname is returned (since this may be different from
2593 the value of `system-name' and should supplant it), otherwise t is
2594 returned to indicate winsock support is present. */)
2595 (Lisp_Object load_now)
2596 {
2597 int have_winsock;
2598
2599 have_winsock = init_winsock (!NILP (load_now));
2600 if (have_winsock)
2601 {
2602 if (winsock_lib != NULL)
2603 {
2604 /* Return new value for system-name. The best way to do this
2605 is to call init_system_name, saving and restoring the
2606 original value to avoid side-effects. */
2607 Lisp_Object orig_hostname = Vsystem_name;
2608 Lisp_Object hostname;
2609
2610 init_system_name ();
2611 hostname = Vsystem_name;
2612 Vsystem_name = orig_hostname;
2613 return hostname;
2614 }
2615 return Qt;
2616 }
2617 return Qnil;
2618 }
2619
2620 DEFUN ("w32-unload-winsock", Fw32_unload_winsock, Sw32_unload_winsock,
2621 0, 0, 0,
2622 doc: /* Unload the Windows socket library `winsock' if loaded.
2623 This is provided to allow dial-up socket connections to be disconnected
2624 when no longer needed. Returns nil without unloading winsock if any
2625 socket connections still exist. */)
2626 (void)
2627 {
2628 return term_winsock () ? Qt : Qnil;
2629 }
2630
2631 \f
2632 /* Some miscellaneous functions that are Windows specific, but not GUI
2633 specific (ie. are applicable in terminal or batch mode as well). */
2634
2635 DEFUN ("w32-short-file-name", Fw32_short_file_name, Sw32_short_file_name, 1, 1, 0,
2636 doc: /* Return the short file name version (8.3) of the full path of FILENAME.
2637 If FILENAME does not exist, return nil.
2638 All path elements in FILENAME are converted to their short names. */)
2639 (Lisp_Object filename)
2640 {
2641 char shortname[MAX_PATH];
2642
2643 CHECK_STRING (filename);
2644
2645 /* first expand it. */
2646 filename = Fexpand_file_name (filename, Qnil);
2647
2648 /* luckily, this returns the short version of each element in the path. */
2649 if (GetShortPathName (SDATA (ENCODE_FILE (filename)), shortname, MAX_PATH) == 0)
2650 return Qnil;
2651
2652 dostounix_filename (shortname, 0);
2653
2654 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2655 return build_string (shortname);
2656 }
2657
2658
2659 DEFUN ("w32-long-file-name", Fw32_long_file_name, Sw32_long_file_name,
2660 1, 1, 0,
2661 doc: /* Return the long file name version of the full path of FILENAME.
2662 If FILENAME does not exist, return nil.
2663 All path elements in FILENAME are converted to their long names. */)
2664 (Lisp_Object filename)
2665 {
2666 char longname[ MAX_PATH ];
2667 int drive_only = 0;
2668
2669 CHECK_STRING (filename);
2670
2671 if (SBYTES (filename) == 2
2672 && *(SDATA (filename) + 1) == ':')
2673 drive_only = 1;
2674
2675 /* first expand it. */
2676 filename = Fexpand_file_name (filename, Qnil);
2677
2678 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename)), longname, MAX_PATH))
2679 return Qnil;
2680
2681 dostounix_filename (longname, 0);
2682
2683 /* If we were passed only a drive, make sure that a slash is not appended
2684 for consistency with directories. Allow for drive mapping via SUBST
2685 in case expand-file-name is ever changed to expand those. */
2686 if (drive_only && longname[1] == ':' && longname[2] == '/' && !longname[3])
2687 longname[2] = '\0';
2688
2689 return DECODE_FILE (build_string (longname));
2690 }
2691
2692 DEFUN ("w32-set-process-priority", Fw32_set_process_priority,
2693 Sw32_set_process_priority, 2, 2, 0,
2694 doc: /* Set the priority of PROCESS to PRIORITY.
2695 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2696 priority of the process whose pid is PROCESS is changed.
2697 PRIORITY should be one of the symbols high, normal, or low;
2698 any other symbol will be interpreted as normal.
2699
2700 If successful, the return value is t, otherwise nil. */)
2701 (Lisp_Object process, Lisp_Object priority)
2702 {
2703 HANDLE proc_handle = GetCurrentProcess ();
2704 DWORD priority_class = NORMAL_PRIORITY_CLASS;
2705 Lisp_Object result = Qnil;
2706
2707 CHECK_SYMBOL (priority);
2708
2709 if (!NILP (process))
2710 {
2711 DWORD pid;
2712 child_process *cp;
2713
2714 CHECK_NUMBER (process);
2715
2716 /* Allow pid to be an internally generated one, or one obtained
2717 externally. This is necessary because real pids on Windows 95 are
2718 negative. */
2719
2720 pid = XINT (process);
2721 cp = find_child_pid (pid);
2722 if (cp != NULL)
2723 pid = cp->procinfo.dwProcessId;
2724
2725 proc_handle = OpenProcess (PROCESS_SET_INFORMATION, FALSE, pid);
2726 }
2727
2728 if (EQ (priority, Qhigh))
2729 priority_class = HIGH_PRIORITY_CLASS;
2730 else if (EQ (priority, Qlow))
2731 priority_class = IDLE_PRIORITY_CLASS;
2732
2733 if (proc_handle != NULL)
2734 {
2735 if (SetPriorityClass (proc_handle, priority_class))
2736 result = Qt;
2737 if (!NILP (process))
2738 CloseHandle (proc_handle);
2739 }
2740
2741 return result;
2742 }
2743
2744 #ifdef HAVE_LANGINFO_CODESET
2745 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2746 char *
2747 nl_langinfo (nl_item item)
2748 {
2749 /* Conversion of Posix item numbers to their Windows equivalents. */
2750 static const LCTYPE w32item[] = {
2751 LOCALE_IDEFAULTANSICODEPAGE,
2752 LOCALE_SDAYNAME1, LOCALE_SDAYNAME2, LOCALE_SDAYNAME3,
2753 LOCALE_SDAYNAME4, LOCALE_SDAYNAME5, LOCALE_SDAYNAME6, LOCALE_SDAYNAME7,
2754 LOCALE_SMONTHNAME1, LOCALE_SMONTHNAME2, LOCALE_SMONTHNAME3,
2755 LOCALE_SMONTHNAME4, LOCALE_SMONTHNAME5, LOCALE_SMONTHNAME6,
2756 LOCALE_SMONTHNAME7, LOCALE_SMONTHNAME8, LOCALE_SMONTHNAME9,
2757 LOCALE_SMONTHNAME10, LOCALE_SMONTHNAME11, LOCALE_SMONTHNAME12
2758 };
2759
2760 static char *nl_langinfo_buf = NULL;
2761 static int nl_langinfo_len = 0;
2762
2763 if (nl_langinfo_len <= 0)
2764 nl_langinfo_buf = xmalloc (nl_langinfo_len = 1);
2765
2766 if (item < 0 || item >= _NL_NUM)
2767 nl_langinfo_buf[0] = 0;
2768 else
2769 {
2770 LCID cloc = GetThreadLocale ();
2771 int need_len = GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2772 NULL, 0);
2773
2774 if (need_len <= 0)
2775 nl_langinfo_buf[0] = 0;
2776 else
2777 {
2778 if (item == CODESET)
2779 {
2780 need_len += 2; /* for the "cp" prefix */
2781 if (need_len < 8) /* for the case we call GetACP */
2782 need_len = 8;
2783 }
2784 if (nl_langinfo_len <= need_len)
2785 nl_langinfo_buf = xrealloc (nl_langinfo_buf,
2786 nl_langinfo_len = need_len);
2787 if (!GetLocaleInfo (cloc, w32item[item] | LOCALE_USE_CP_ACP,
2788 nl_langinfo_buf, nl_langinfo_len))
2789 nl_langinfo_buf[0] = 0;
2790 else if (item == CODESET)
2791 {
2792 if (strcmp (nl_langinfo_buf, "0") == 0 /* CP_ACP */
2793 || strcmp (nl_langinfo_buf, "1") == 0) /* CP_OEMCP */
2794 sprintf (nl_langinfo_buf, "cp%u", GetACP ());
2795 else
2796 {
2797 memmove (nl_langinfo_buf + 2, nl_langinfo_buf,
2798 strlen (nl_langinfo_buf) + 1);
2799 nl_langinfo_buf[0] = 'c';
2800 nl_langinfo_buf[1] = 'p';
2801 }
2802 }
2803 }
2804 }
2805 return nl_langinfo_buf;
2806 }
2807 #endif /* HAVE_LANGINFO_CODESET */
2808
2809 DEFUN ("w32-get-locale-info", Fw32_get_locale_info,
2810 Sw32_get_locale_info, 1, 2, 0,
2811 doc: /* Return information about the Windows locale LCID.
2812 By default, return a three letter locale code which encodes the default
2813 language as the first two characters, and the country or regional variant
2814 as the third letter. For example, ENU refers to `English (United States)',
2815 while ENC means `English (Canadian)'.
2816
2817 If the optional argument LONGFORM is t, the long form of the locale
2818 name is returned, e.g. `English (United States)' instead; if LONGFORM
2819 is a number, it is interpreted as an LCTYPE constant and the corresponding
2820 locale information is returned.
2821
2822 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2823 (Lisp_Object lcid, Lisp_Object longform)
2824 {
2825 int got_abbrev;
2826 int got_full;
2827 char abbrev_name[32] = { 0 };
2828 char full_name[256] = { 0 };
2829
2830 CHECK_NUMBER (lcid);
2831
2832 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2833 return Qnil;
2834
2835 if (NILP (longform))
2836 {
2837 got_abbrev = GetLocaleInfo (XINT (lcid),
2838 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
2839 abbrev_name, sizeof (abbrev_name));
2840 if (got_abbrev)
2841 return build_string (abbrev_name);
2842 }
2843 else if (EQ (longform, Qt))
2844 {
2845 got_full = GetLocaleInfo (XINT (lcid),
2846 LOCALE_SLANGUAGE | LOCALE_USE_CP_ACP,
2847 full_name, sizeof (full_name));
2848 if (got_full)
2849 return DECODE_SYSTEM (build_string (full_name));
2850 }
2851 else if (NUMBERP (longform))
2852 {
2853 got_full = GetLocaleInfo (XINT (lcid),
2854 XINT (longform),
2855 full_name, sizeof (full_name));
2856 /* GetLocaleInfo's return value includes the terminating null
2857 character, when the returned information is a string, whereas
2858 make_unibyte_string needs the string length without the
2859 terminating null. */
2860 if (got_full)
2861 return make_unibyte_string (full_name, got_full - 1);
2862 }
2863
2864 return Qnil;
2865 }
2866
2867
2868 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id,
2869 Sw32_get_current_locale_id, 0, 0, 0,
2870 doc: /* Return Windows locale id for current locale setting.
2871 This is a numerical value; use `w32-get-locale-info' to convert to a
2872 human-readable form. */)
2873 (void)
2874 {
2875 return make_number (GetThreadLocale ());
2876 }
2877
2878 static DWORD
2879 int_from_hex (char * s)
2880 {
2881 DWORD val = 0;
2882 static char hex[] = "0123456789abcdefABCDEF";
2883 char * p;
2884
2885 while (*s && (p = strchr (hex, *s)) != NULL)
2886 {
2887 unsigned digit = p - hex;
2888 if (digit > 15)
2889 digit -= 6;
2890 val = val * 16 + digit;
2891 s++;
2892 }
2893 return val;
2894 }
2895
2896 /* We need to build a global list, since the EnumSystemLocale callback
2897 function isn't given a context pointer. */
2898 Lisp_Object Vw32_valid_locale_ids;
2899
2900 static BOOL CALLBACK
2901 enum_locale_fn (LPTSTR localeNum)
2902 {
2903 DWORD id = int_from_hex (localeNum);
2904 Vw32_valid_locale_ids = Fcons (make_number (id), Vw32_valid_locale_ids);
2905 return TRUE;
2906 }
2907
2908 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids,
2909 Sw32_get_valid_locale_ids, 0, 0, 0,
2910 doc: /* Return list of all valid Windows locale ids.
2911 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2912 human-readable form. */)
2913 (void)
2914 {
2915 Vw32_valid_locale_ids = Qnil;
2916
2917 EnumSystemLocales (enum_locale_fn, LCID_SUPPORTED);
2918
2919 Vw32_valid_locale_ids = Fnreverse (Vw32_valid_locale_ids);
2920 return Vw32_valid_locale_ids;
2921 }
2922
2923
2924 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id, Sw32_get_default_locale_id, 0, 1, 0,
2925 doc: /* Return Windows locale id for default locale setting.
2926 By default, the system default locale setting is returned; if the optional
2927 parameter USERP is non-nil, the user default locale setting is returned.
2928 This is a numerical value; use `w32-get-locale-info' to convert to a
2929 human-readable form. */)
2930 (Lisp_Object userp)
2931 {
2932 if (NILP (userp))
2933 return make_number (GetSystemDefaultLCID ());
2934 return make_number (GetUserDefaultLCID ());
2935 }
2936
2937
2938 DEFUN ("w32-set-current-locale", Fw32_set_current_locale, Sw32_set_current_locale, 1, 1, 0,
2939 doc: /* Make Windows locale LCID be the current locale setting for Emacs.
2940 If successful, the new locale id is returned, otherwise nil. */)
2941 (Lisp_Object lcid)
2942 {
2943 CHECK_NUMBER (lcid);
2944
2945 if (!IsValidLocale (XINT (lcid), LCID_SUPPORTED))
2946 return Qnil;
2947
2948 if (!SetThreadLocale (XINT (lcid)))
2949 return Qnil;
2950
2951 /* Need to set input thread locale if present. */
2952 if (dwWindowsThreadId)
2953 /* Reply is not needed. */
2954 PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETLOCALE, XINT (lcid), 0);
2955
2956 return make_number (GetThreadLocale ());
2957 }
2958
2959
2960 /* We need to build a global list, since the EnumCodePages callback
2961 function isn't given a context pointer. */
2962 Lisp_Object Vw32_valid_codepages;
2963
2964 static BOOL CALLBACK
2965 enum_codepage_fn (LPTSTR codepageNum)
2966 {
2967 DWORD id = atoi (codepageNum);
2968 Vw32_valid_codepages = Fcons (make_number (id), Vw32_valid_codepages);
2969 return TRUE;
2970 }
2971
2972 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages,
2973 Sw32_get_valid_codepages, 0, 0, 0,
2974 doc: /* Return list of all valid Windows codepages. */)
2975 (void)
2976 {
2977 Vw32_valid_codepages = Qnil;
2978
2979 EnumSystemCodePages (enum_codepage_fn, CP_SUPPORTED);
2980
2981 Vw32_valid_codepages = Fnreverse (Vw32_valid_codepages);
2982 return Vw32_valid_codepages;
2983 }
2984
2985
2986 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage,
2987 Sw32_get_console_codepage, 0, 0, 0,
2988 doc: /* Return current Windows codepage for console input. */)
2989 (void)
2990 {
2991 return make_number (GetConsoleCP ());
2992 }
2993
2994
2995 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage,
2996 Sw32_set_console_codepage, 1, 1, 0,
2997 doc: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2998 This codepage setting affects keyboard input in tty mode.
2999 If successful, the new CP is returned, otherwise nil. */)
3000 (Lisp_Object cp)
3001 {
3002 CHECK_NUMBER (cp);
3003
3004 if (!IsValidCodePage (XINT (cp)))
3005 return Qnil;
3006
3007 if (!SetConsoleCP (XINT (cp)))
3008 return Qnil;
3009
3010 return make_number (GetConsoleCP ());
3011 }
3012
3013
3014 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage,
3015 Sw32_get_console_output_codepage, 0, 0, 0,
3016 doc: /* Return current Windows codepage for console output. */)
3017 (void)
3018 {
3019 return make_number (GetConsoleOutputCP ());
3020 }
3021
3022
3023 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage,
3024 Sw32_set_console_output_codepage, 1, 1, 0,
3025 doc: /* Make Windows codepage CP be the codepage for Emacs console output.
3026 This codepage setting affects display in tty mode.
3027 If successful, the new CP is returned, otherwise nil. */)
3028 (Lisp_Object cp)
3029 {
3030 CHECK_NUMBER (cp);
3031
3032 if (!IsValidCodePage (XINT (cp)))
3033 return Qnil;
3034
3035 if (!SetConsoleOutputCP (XINT (cp)))
3036 return Qnil;
3037
3038 return make_number (GetConsoleOutputCP ());
3039 }
3040
3041
3042 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset,
3043 Sw32_get_codepage_charset, 1, 1, 0,
3044 doc: /* Return charset ID corresponding to codepage CP.
3045 Returns nil if the codepage is not valid. */)
3046 (Lisp_Object cp)
3047 {
3048 CHARSETINFO info;
3049
3050 CHECK_NUMBER (cp);
3051
3052 if (!IsValidCodePage (XINT (cp)))
3053 return Qnil;
3054
3055 if (TranslateCharsetInfo ((DWORD *) XINT (cp), &info, TCI_SRCCODEPAGE))
3056 return make_number (info.ciCharset);
3057
3058 return Qnil;
3059 }
3060
3061
3062 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts,
3063 Sw32_get_valid_keyboard_layouts, 0, 0, 0,
3064 doc: /* Return list of Windows keyboard languages and layouts.
3065 The return value is a list of pairs of language id and layout id. */)
3066 (void)
3067 {
3068 int num_layouts = GetKeyboardLayoutList (0, NULL);
3069 HKL * layouts = (HKL *) alloca (num_layouts * sizeof (HKL));
3070 Lisp_Object obj = Qnil;
3071
3072 if (GetKeyboardLayoutList (num_layouts, layouts) == num_layouts)
3073 {
3074 while (--num_layouts >= 0)
3075 {
3076 DWORD kl = (DWORD) layouts[num_layouts];
3077
3078 obj = Fcons (Fcons (make_number (kl & 0xffff),
3079 make_number ((kl >> 16) & 0xffff)),
3080 obj);
3081 }
3082 }
3083
3084 return obj;
3085 }
3086
3087
3088 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout,
3089 Sw32_get_keyboard_layout, 0, 0, 0,
3090 doc: /* Return current Windows keyboard language and layout.
3091 The return value is the cons of the language id and the layout id. */)
3092 (void)
3093 {
3094 DWORD kl = (DWORD) GetKeyboardLayout (dwWindowsThreadId);
3095
3096 return Fcons (make_number (kl & 0xffff),
3097 make_number ((kl >> 16) & 0xffff));
3098 }
3099
3100
3101 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout,
3102 Sw32_set_keyboard_layout, 1, 1, 0,
3103 doc: /* Make LAYOUT be the current keyboard layout for Emacs.
3104 The keyboard layout setting affects interpretation of keyboard input.
3105 If successful, the new layout id is returned, otherwise nil. */)
3106 (Lisp_Object layout)
3107 {
3108 DWORD kl;
3109
3110 CHECK_CONS (layout);
3111 CHECK_NUMBER_CAR (layout);
3112 CHECK_NUMBER_CDR (layout);
3113
3114 kl = (XINT (XCAR (layout)) & 0xffff)
3115 | (XINT (XCDR (layout)) << 16);
3116
3117 /* Synchronize layout with input thread. */
3118 if (dwWindowsThreadId)
3119 {
3120 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_SETKEYBOARDLAYOUT,
3121 (WPARAM) kl, 0))
3122 {
3123 MSG msg;
3124 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3125
3126 if (msg.wParam == 0)
3127 return Qnil;
3128 }
3129 }
3130 else if (!ActivateKeyboardLayout ((HKL) kl, 0))
3131 return Qnil;
3132
3133 return Fw32_get_keyboard_layout ();
3134 }
3135
3136 \f
3137 void
3138 syms_of_ntproc (void)
3139 {
3140 DEFSYM (Qhigh, "high");
3141 DEFSYM (Qlow, "low");
3142
3143 defsubr (&Sw32_has_winsock);
3144 defsubr (&Sw32_unload_winsock);
3145
3146 defsubr (&Sw32_short_file_name);
3147 defsubr (&Sw32_long_file_name);
3148 defsubr (&Sw32_set_process_priority);
3149 defsubr (&Sw32_get_locale_info);
3150 defsubr (&Sw32_get_current_locale_id);
3151 defsubr (&Sw32_get_default_locale_id);
3152 defsubr (&Sw32_get_valid_locale_ids);
3153 defsubr (&Sw32_set_current_locale);
3154
3155 defsubr (&Sw32_get_console_codepage);
3156 defsubr (&Sw32_set_console_codepage);
3157 defsubr (&Sw32_get_console_output_codepage);
3158 defsubr (&Sw32_set_console_output_codepage);
3159 defsubr (&Sw32_get_valid_codepages);
3160 defsubr (&Sw32_get_codepage_charset);
3161
3162 defsubr (&Sw32_get_valid_keyboard_layouts);
3163 defsubr (&Sw32_get_keyboard_layout);
3164 defsubr (&Sw32_set_keyboard_layout);
3165
3166 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args,
3167 doc: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3168 Because Windows does not directly pass argv arrays to child processes,
3169 programs have to reconstruct the argv array by parsing the command
3170 line string. For an argument to contain a space, it must be enclosed
3171 in double quotes or it will be parsed as multiple arguments.
3172
3173 If the value is a character, that character will be used to escape any
3174 quote characters that appear, otherwise a suitable escape character
3175 will be chosen based on the type of the program. */);
3176 Vw32_quote_process_args = Qt;
3177
3178 DEFVAR_LISP ("w32-start-process-show-window",
3179 Vw32_start_process_show_window,
3180 doc: /* When nil, new child processes hide their windows.
3181 When non-nil, they show their window in the method of their choice.
3182 This variable doesn't affect GUI applications, which will never be hidden. */);
3183 Vw32_start_process_show_window = Qnil;
3184
3185 DEFVAR_LISP ("w32-start-process-share-console",
3186 Vw32_start_process_share_console,
3187 doc: /* When nil, new child processes are given a new console.
3188 When non-nil, they share the Emacs console; this has the limitation of
3189 allowing only one DOS subprocess to run at a time (whether started directly
3190 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3191 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3192 otherwise respond to interrupts from Emacs. */);
3193 Vw32_start_process_share_console = Qnil;
3194
3195 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3196 Vw32_start_process_inherit_error_mode,
3197 doc: /* When nil, new child processes revert to the default error mode.
3198 When non-nil, they inherit their error mode setting from Emacs, which stops
3199 them blocking when trying to access unmounted drives etc. */);
3200 Vw32_start_process_inherit_error_mode = Qt;
3201
3202 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay,
3203 doc: /* Forced delay before reading subprocess output.
3204 This is done to improve the buffering of subprocess output, by
3205 avoiding the inefficiency of frequently reading small amounts of data.
3206
3207 If positive, the value is the number of milliseconds to sleep before
3208 reading the subprocess output. If negative, the magnitude is the number
3209 of time slices to wait (effectively boosting the priority of the child
3210 process temporarily). A value of zero disables waiting entirely. */);
3211 w32_pipe_read_delay = 50;
3212
3213 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names,
3214 doc: /* Non-nil means convert all-upper case file names to lower case.
3215 This applies when performing completions and file name expansion.
3216 Note that the value of this setting also affects remote file names,
3217 so you probably don't want to set to non-nil if you use case-sensitive
3218 filesystems via ange-ftp. */);
3219 Vw32_downcase_file_names = Qnil;
3220
3221 #if 0
3222 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes,
3223 doc: /* Non-nil means attempt to fake realistic inode values.
3224 This works by hashing the truename of files, and should detect
3225 aliasing between long and short (8.3 DOS) names, but can have
3226 false positives because of hash collisions. Note that determining
3227 the truename of a file can be slow. */);
3228 Vw32_generate_fake_inodes = Qnil;
3229 #endif
3230
3231 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes,
3232 doc: /* Non-nil means determine accurate file attributes in `file-attributes'.
3233 This option controls whether to issue additional system calls to determine
3234 accurate link counts, file type, and ownership information. It is more
3235 useful for files on NTFS volumes, where hard links and file security are
3236 supported, than on volumes of the FAT family.
3237
3238 Without these system calls, link count will always be reported as 1 and file
3239 ownership will be attributed to the current user.
3240 The default value `local' means only issue these system calls for files
3241 on local fixed drives. A value of nil means never issue them.
3242 Any other non-nil value means do this even on remote and removable drives
3243 where the performance impact may be noticeable even on modern hardware. */);
3244 Vw32_get_true_file_attributes = Qlocal;
3245
3246 staticpro (&Vw32_valid_locale_ids);
3247 staticpro (&Vw32_valid_codepages);
3248 }
3249 /* end of w32proc.c */