1 /* Process support for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1992, 1995, 1999-2013 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 Drew Bliss Oct 14, 1993
21 Adapted from alarm.c by Tim Fleehart
33 /* must include CRT headers *before* config.h */
44 /* This definition is missing from mingw32 headers. */
45 extern BOOL WINAPI
IsValidLocale (LCID
, DWORD
);
48 #ifdef HAVE_LANGINFO_CODESET
55 #include "w32common.h"
60 #include "syssignal.h"
62 #include "dispextern.h" /* for xstrcasecmp */
65 #define RVA_TO_PTR(var,section,filedata) \
66 ((void *)((section)->PointerToRawData \
67 + ((DWORD_PTR)(var) - (section)->VirtualAddress) \
68 + (filedata).file_base))
70 Lisp_Object Qhigh
, Qlow
;
72 /* Signal handlers...SIG_DFL == 0 so this is initialized correctly. */
73 static signal_handler sig_handlers
[NSIG
];
75 static sigset_t sig_mask
;
77 static CRITICAL_SECTION crit_sig
;
79 /* Improve on the CRT 'signal' implementation so that we could record
80 the SIGCHLD handler and fake interval timers. */
82 sys_signal (int sig
, signal_handler handler
)
86 /* SIGCHLD is needed for supporting subprocesses, see sys_kill
87 below. SIGALRM and SIGPROF are used by setitimer. All the
88 others are the only ones supported by the MS runtime. */
89 if (!(sig
== SIGCHLD
|| sig
== SIGSEGV
|| sig
== SIGILL
90 || sig
== SIGFPE
|| sig
== SIGABRT
|| sig
== SIGTERM
91 || sig
== SIGALRM
|| sig
== SIGPROF
))
96 old
= sig_handlers
[sig
];
97 /* SIGABRT is treated specially because w32.c installs term_ntproc
98 as its handler, so we don't want to override that afterwards.
99 Aborting Emacs works specially anyway: either by calling
100 emacs_abort directly or through terminate_due_to_signal, which
101 calls emacs_abort through emacs_raise. */
102 if (!(sig
== SIGABRT
&& old
== term_ntproc
))
104 sig_handlers
[sig
] = handler
;
105 if (!(sig
== SIGCHLD
|| sig
== SIGALRM
|| sig
== SIGPROF
))
106 signal (sig
, handler
);
111 /* Emulate sigaction. */
113 sigaction (int sig
, const struct sigaction
*act
, struct sigaction
*oact
)
115 signal_handler old
= SIG_DFL
;
119 old
= sys_signal (sig
, act
->sa_handler
);
121 old
= sig_handlers
[sig
];
130 oact
->sa_handler
= old
;
132 oact
->sa_mask
= empty_mask
;
137 /* Emulate signal sets and blocking of signals used by timers. */
140 sigemptyset (sigset_t
*set
)
147 sigaddset (sigset_t
*set
, int signo
)
154 if (signo
< 0 || signo
>= NSIG
)
160 *set
|= (1U << signo
);
166 sigfillset (sigset_t
*set
)
179 sigprocmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
181 if (!(how
== SIG_BLOCK
|| how
== SIG_UNBLOCK
|| how
== SIG_SETMASK
))
202 /* FIXME: Catch signals that are blocked and reissue them when
203 they are unblocked. Important for SIGALRM and SIGPROF only. */
212 pthread_sigmask (int how
, const sigset_t
*set
, sigset_t
*oset
)
214 if (sigprocmask (how
, set
, oset
) == -1)
220 sigismember (const sigset_t
*set
, int signo
)
222 if (signo
< 0 || signo
>= NSIG
)
227 if (signo
> sizeof (*set
) * BITS_PER_CHAR
)
230 return (*set
& (1U << signo
)) != 0;
246 setpgid (pid_t pid
, pid_t pgid
)
257 /* Emulations of interval timers.
259 Limitations: only ITIMER_REAL and ITIMER_PROF are supported.
261 Implementation: a separate thread is started for each timer type,
262 the thread calls the appropriate signal handler when the timer
263 expires, after stopping the thread which installed the timer. */
266 volatile ULONGLONG expire
;
267 volatile ULONGLONG reload
;
268 volatile int terminate
;
270 HANDLE caller_thread
;
274 static ULONGLONG ticks_now
;
275 static struct itimer_data real_itimer
, prof_itimer
;
276 static ULONGLONG clocks_min
;
277 /* If non-zero, itimers are disabled. Used during shutdown, when we
278 delete the critical sections used by the timer threads. */
279 static int disable_itimers
;
281 static CRITICAL_SECTION crit_real
, crit_prof
;
283 /* GetThreadTimes is not available on Windows 9X and possibly also on 2K. */
284 typedef BOOL (WINAPI
*GetThreadTimes_Proc
) (
286 LPFILETIME lpCreationTime
,
287 LPFILETIME lpExitTime
,
288 LPFILETIME lpKernelTime
,
289 LPFILETIME lpUserTime
);
291 static GetThreadTimes_Proc s_pfn_Get_Thread_Times
;
293 #define MAX_SINGLE_SLEEP 30
294 #define TIMER_TICKS_PER_SEC 1000
296 /* Return a suitable time value, in 1-ms units, for THREAD, a handle
297 to a thread. If THREAD is NULL or an invalid handle, return the
298 current wall-clock time since January 1, 1601 (UTC). Otherwise,
299 return the sum of kernel and user times used by THREAD since it was
300 created, plus its creation time. */
302 w32_get_timer_time (HANDLE thread
)
305 int use_system_time
= 1;
306 /* The functions below return times in 100-ns units. */
307 const int tscale
= 10 * TIMER_TICKS_PER_SEC
;
309 if (thread
&& thread
!= INVALID_HANDLE_VALUE
310 && s_pfn_Get_Thread_Times
!= NULL
)
312 FILETIME creation_ftime
, exit_ftime
, kernel_ftime
, user_ftime
;
313 ULARGE_INTEGER temp_creation
, temp_kernel
, temp_user
;
315 if (s_pfn_Get_Thread_Times (thread
, &creation_ftime
, &exit_ftime
,
316 &kernel_ftime
, &user_ftime
))
319 temp_creation
.LowPart
= creation_ftime
.dwLowDateTime
;
320 temp_creation
.HighPart
= creation_ftime
.dwHighDateTime
;
321 temp_kernel
.LowPart
= kernel_ftime
.dwLowDateTime
;
322 temp_kernel
.HighPart
= kernel_ftime
.dwHighDateTime
;
323 temp_user
.LowPart
= user_ftime
.dwLowDateTime
;
324 temp_user
.HighPart
= user_ftime
.dwHighDateTime
;
326 temp_creation
.QuadPart
/ tscale
+ temp_kernel
.QuadPart
/ tscale
327 + temp_user
.QuadPart
/ tscale
;
330 DebPrint (("GetThreadTimes failed with error code %lu\n",
336 FILETIME current_ftime
;
339 GetSystemTimeAsFileTime (¤t_ftime
);
341 temp
.LowPart
= current_ftime
.dwLowDateTime
;
342 temp
.HighPart
= current_ftime
.dwHighDateTime
;
344 retval
= temp
.QuadPart
/ tscale
;
350 /* Thread function for a timer thread. */
352 timer_loop (LPVOID arg
)
354 struct itimer_data
*itimer
= (struct itimer_data
*)arg
;
355 int which
= itimer
->type
;
356 int sig
= (which
== ITIMER_REAL
) ? SIGALRM
: SIGPROF
;
357 CRITICAL_SECTION
*crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
358 const DWORD max_sleep
= MAX_SINGLE_SLEEP
* 1000 / TIMER_TICKS_PER_SEC
;
359 HANDLE hth
= (which
== ITIMER_REAL
) ? NULL
: itimer
->caller_thread
;
364 signal_handler handler
;
365 ULONGLONG now
, expire
, reload
;
367 /* Load new values if requested by setitimer. */
368 EnterCriticalSection (crit
);
369 expire
= itimer
->expire
;
370 reload
= itimer
->reload
;
371 LeaveCriticalSection (crit
);
372 if (itimer
->terminate
)
382 if (expire
> (now
= w32_get_timer_time (hth
)))
383 sleep_time
= expire
- now
;
386 /* Don't sleep too long at a time, to be able to see the
387 termination flag without too long a delay. */
388 while (sleep_time
> max_sleep
)
390 if (itimer
->terminate
)
393 EnterCriticalSection (crit
);
394 expire
= itimer
->expire
;
395 LeaveCriticalSection (crit
);
397 (expire
> (now
= w32_get_timer_time (hth
))) ? expire
- now
: 0;
399 if (itimer
->terminate
)
403 Sleep (sleep_time
* 1000 / TIMER_TICKS_PER_SEC
);
404 /* Always sleep past the expiration time, to make sure we
405 never call the handler _before_ the expiration time,
406 always slightly after it. Sleep(5) makes sure we don't
407 hog the CPU by calling 'w32_get_timer_time' with high
408 frequency, and also let other threads work. */
409 while (w32_get_timer_time (hth
) < expire
)
413 EnterCriticalSection (crit
);
414 expire
= itimer
->expire
;
415 LeaveCriticalSection (crit
);
420 handler
= sig_handlers
[sig
];
421 if (!(handler
== SIG_DFL
|| handler
== SIG_IGN
|| handler
== SIG_ERR
)
422 /* FIXME: Don't ignore masked signals. Instead, record that
423 they happened and reissue them when the signal is
425 && !sigismember (&sig_mask
, sig
)
426 /* Simulate masking of SIGALRM and SIGPROF when processing
428 && !fatal_error_in_progress
429 && itimer
->caller_thread
)
431 /* Simulate a signal delivered to the thread which installed
432 the timer, by suspending that thread while the handler
434 HANDLE th
= itimer
->caller_thread
;
435 DWORD result
= SuspendThread (th
);
437 if (result
== (DWORD
)-1)
444 /* Update expiration time and loop. */
445 EnterCriticalSection (crit
);
446 expire
= itimer
->expire
;
449 LeaveCriticalSection (crit
);
452 reload
= itimer
->reload
;
455 now
= w32_get_timer_time (hth
);
458 ULONGLONG lag
= now
- expire
;
460 /* If we missed some opportunities (presumably while
461 sleeping or while the signal handler ran), skip
464 expire
= now
- (lag
% reload
);
470 expire
= 0; /* become idle */
471 itimer
->expire
= expire
;
472 LeaveCriticalSection (crit
);
478 stop_timer_thread (int which
)
480 struct itimer_data
*itimer
=
481 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
483 DWORD err
, exit_code
= 255;
486 /* Signal the thread that it should terminate. */
487 itimer
->terminate
= 1;
489 if (itimer
->timer_thread
== NULL
)
492 /* Wait for the timer thread to terminate voluntarily, then kill it
493 if it doesn't. This loop waits twice more than the maximum
494 amount of time a timer thread sleeps, see above. */
495 for (i
= 0; i
< MAX_SINGLE_SLEEP
/ 5; i
++)
497 if (!((status
= GetExitCodeThread (itimer
->timer_thread
, &exit_code
))
498 && exit_code
== STILL_ACTIVE
))
502 if ((status
== FALSE
&& (err
= GetLastError ()) == ERROR_INVALID_HANDLE
)
503 || exit_code
== STILL_ACTIVE
)
505 if (!(status
== FALSE
&& err
== ERROR_INVALID_HANDLE
))
506 TerminateThread (itimer
->timer_thread
, 0);
510 CloseHandle (itimer
->timer_thread
);
511 itimer
->timer_thread
= NULL
;
512 if (itimer
->caller_thread
)
514 CloseHandle (itimer
->caller_thread
);
515 itimer
->caller_thread
= NULL
;
519 /* This is called at shutdown time from term_ntproc. */
523 if (real_itimer
.timer_thread
)
524 stop_timer_thread (ITIMER_REAL
);
525 if (prof_itimer
.timer_thread
)
526 stop_timer_thread (ITIMER_PROF
);
528 /* We are going to delete the critical sections, so timers cannot
532 DeleteCriticalSection (&crit_real
);
533 DeleteCriticalSection (&crit_prof
);
534 DeleteCriticalSection (&crit_sig
);
537 /* This is called at initialization time from init_ntproc. */
541 /* GetThreadTimes is not available on all versions of Windows, so
542 need to probe for its availability dynamically, and call it
543 through a pointer. */
544 s_pfn_Get_Thread_Times
= NULL
; /* in case dumped Emacs comes with a value */
545 if (os_subtype
!= OS_9X
)
546 s_pfn_Get_Thread_Times
=
547 (GetThreadTimes_Proc
)GetProcAddress (GetModuleHandle ("kernel32.dll"),
550 /* Make sure we start with zeroed out itimer structures, since
551 dumping may have left there traces of threads long dead. */
552 memset (&real_itimer
, 0, sizeof real_itimer
);
553 memset (&prof_itimer
, 0, sizeof prof_itimer
);
555 InitializeCriticalSection (&crit_real
);
556 InitializeCriticalSection (&crit_prof
);
557 InitializeCriticalSection (&crit_sig
);
563 start_timer_thread (int which
)
567 struct itimer_data
*itimer
=
568 (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
570 if (itimer
->timer_thread
571 && GetExitCodeThread (itimer
->timer_thread
, &exit_code
)
572 && exit_code
== STILL_ACTIVE
)
575 /* Clean up after possibly exited thread. */
576 if (itimer
->timer_thread
)
578 CloseHandle (itimer
->timer_thread
);
579 itimer
->timer_thread
= NULL
;
581 if (itimer
->caller_thread
)
583 CloseHandle (itimer
->caller_thread
);
584 itimer
->caller_thread
= NULL
;
587 /* Start a new thread. */
588 if (!DuplicateHandle (GetCurrentProcess (), GetCurrentThread (),
589 GetCurrentProcess (), &th
, 0, FALSE
,
590 DUPLICATE_SAME_ACCESS
))
595 itimer
->terminate
= 0;
596 itimer
->type
= which
;
597 itimer
->caller_thread
= th
;
598 /* Request that no more than 64KB of stack be reserved for this
599 thread, to avoid reserving too much memory, which would get in
600 the way of threads we start to wait for subprocesses. See also
602 itimer
->timer_thread
= CreateThread (NULL
, 64 * 1024, timer_loop
,
603 (void *)itimer
, 0x00010000, NULL
);
605 if (!itimer
->timer_thread
)
607 CloseHandle (itimer
->caller_thread
);
608 itimer
->caller_thread
= NULL
;
613 /* This is needed to make sure that the timer thread running for
614 profiling gets CPU as soon as the Sleep call terminates. */
615 if (which
== ITIMER_PROF
)
616 SetThreadPriority (itimer
->timer_thread
, THREAD_PRIORITY_TIME_CRITICAL
);
621 /* Most of the code of getitimer and setitimer (but not of their
622 subroutines) was shamelessly stolen from itimer.c in the DJGPP
623 library, see www.delorie.com/djgpp. */
625 getitimer (int which
, struct itimerval
*value
)
627 volatile ULONGLONG
*t_expire
;
628 volatile ULONGLONG
*t_reload
;
629 ULONGLONG expire
, reload
;
631 CRITICAL_SECTION
*crit
;
632 struct itimer_data
*itimer
;
643 if (which
!= ITIMER_REAL
&& which
!= ITIMER_PROF
)
649 itimer
= (which
== ITIMER_REAL
) ? &real_itimer
: &prof_itimer
;
651 ticks_now
= w32_get_timer_time ((which
== ITIMER_REAL
)
653 : GetCurrentThread ());
655 t_expire
= &itimer
->expire
;
656 t_reload
= &itimer
->reload
;
657 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
659 EnterCriticalSection (crit
);
662 LeaveCriticalSection (crit
);
667 value
->it_value
.tv_sec
= expire
/ TIMER_TICKS_PER_SEC
;
669 (expire
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
670 value
->it_value
.tv_usec
= usecs
;
671 value
->it_interval
.tv_sec
= reload
/ TIMER_TICKS_PER_SEC
;
673 (reload
% TIMER_TICKS_PER_SEC
) * (__int64
)1000000 / TIMER_TICKS_PER_SEC
;
674 value
->it_interval
.tv_usec
= usecs
;
680 setitimer(int which
, struct itimerval
*value
, struct itimerval
*ovalue
)
682 volatile ULONGLONG
*t_expire
, *t_reload
;
683 ULONGLONG expire
, reload
, expire_old
, reload_old
;
685 CRITICAL_SECTION
*crit
;
686 struct itimerval tem
, *ptem
;
691 /* Posix systems expect timer values smaller than the resolution of
692 the system clock be rounded up to the clock resolution. First
693 time we are called, measure the clock tick resolution. */
698 for (t1
= w32_get_timer_time (NULL
);
699 (t2
= w32_get_timer_time (NULL
)) == t1
; )
701 clocks_min
= t2
- t1
;
709 if (getitimer (which
, ptem
)) /* also sets ticks_now */
710 return -1; /* errno already set */
713 (which
== ITIMER_REAL
) ? &real_itimer
.expire
: &prof_itimer
.expire
;
715 (which
== ITIMER_REAL
) ? &real_itimer
.reload
: &prof_itimer
.reload
;
717 crit
= (which
== ITIMER_REAL
) ? &crit_real
: &crit_prof
;
720 || (value
->it_value
.tv_sec
== 0 && value
->it_value
.tv_usec
== 0))
722 EnterCriticalSection (crit
);
723 /* Disable the timer. */
726 LeaveCriticalSection (crit
);
730 reload
= value
->it_interval
.tv_sec
* TIMER_TICKS_PER_SEC
;
732 usecs
= value
->it_interval
.tv_usec
;
733 if (value
->it_interval
.tv_sec
== 0
734 && usecs
&& usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
738 usecs
*= TIMER_TICKS_PER_SEC
;
739 reload
+= usecs
/ 1000000;
742 expire
= value
->it_value
.tv_sec
* TIMER_TICKS_PER_SEC
;
743 usecs
= value
->it_value
.tv_usec
;
744 if (value
->it_value
.tv_sec
== 0
745 && usecs
* TIMER_TICKS_PER_SEC
< clocks_min
* 1000000)
749 usecs
*= TIMER_TICKS_PER_SEC
;
750 expire
+= usecs
/ 1000000;
755 EnterCriticalSection (crit
);
756 expire_old
= *t_expire
;
757 reload_old
= *t_reload
;
758 if (!(expire
== expire_old
&& reload
== reload_old
))
763 LeaveCriticalSection (crit
);
765 return start_timer_thread (which
);
771 #ifdef HAVE_SETITIMER
772 struct itimerval new_values
, old_values
;
774 new_values
.it_value
.tv_sec
= seconds
;
775 new_values
.it_value
.tv_usec
= 0;
776 new_values
.it_interval
.tv_sec
= new_values
.it_interval
.tv_usec
= 0;
778 if (setitimer (ITIMER_REAL
, &new_values
, &old_values
) < 0)
780 return old_values
.it_value
.tv_sec
;
786 /* Defined in <process.h> which conflicts with the local copy */
789 /* Child process management list. */
790 int child_proc_count
= 0;
791 child_process child_procs
[ MAX_CHILDREN
];
793 static DWORD WINAPI
reader_thread (void *arg
);
795 /* Find an unused process slot. */
802 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
803 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
805 if (child_proc_count
== MAX_CHILDREN
)
807 cp
= &child_procs
[child_proc_count
++];
810 memset (cp
, 0, sizeof (*cp
));
813 cp
->procinfo
.hProcess
= NULL
;
814 cp
->status
= STATUS_READ_ERROR
;
815 cp
->input_file
= NULL
;
816 cp
->pending_deletion
= 0;
818 /* use manual reset event so that select() will function properly */
819 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
822 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
823 if (cp
->char_consumed
)
825 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
826 It means that the 64K stack we are requesting in the 2nd
827 argument is how much memory should be reserved for the
828 stack. If we don't use this flag, the memory requested
829 by the 2nd argument is the amount actually _committed_,
830 but Windows reserves 8MB of memory for each thread's
831 stack. (The 8MB figure comes from the -stack
832 command-line argument we pass to the linker when building
833 Emacs, but that's because we need a large stack for
834 Emacs's main thread.) Since we request 2GB of reserved
835 memory at startup (see w32heap.c), which is close to the
836 maximum memory available for a 32-bit process on Windows,
837 the 8MB reservation for each thread causes failures in
838 starting subprocesses, because we create a thread running
839 reader_thread for each subprocess. As 8MB of stack is
840 way too much for reader_thread, forcing Windows to
841 reserve less wins the day. */
842 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
853 delete_child (child_process
*cp
)
857 /* Should not be deleting a child that is still needed. */
858 for (i
= 0; i
< MAXDESC
; i
++)
859 if (fd_info
[i
].cp
== cp
)
862 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
865 /* Delete the child's temporary input file, if any, that is pending
869 if (cp
->pending_deletion
)
871 if (unlink (cp
->input_file
))
872 DebPrint (("delete_child.unlink (%s) failed, errno: %d\n",
873 cp
->input_file
, errno
));
874 cp
->pending_deletion
= 0;
876 xfree (cp
->input_file
);
877 cp
->input_file
= NULL
;
880 /* reap thread if necessary */
885 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
887 /* let the thread exit cleanly if possible */
888 cp
->status
= STATUS_READ_ERROR
;
889 SetEvent (cp
->char_consumed
);
891 /* We used to forcibly terminate the thread here, but it
892 is normally unnecessary, and in abnormal cases, the worst that
893 will happen is we have an extra idle thread hanging around
894 waiting for the zombie process. */
895 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
897 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
898 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
899 TerminateThread (cp
->thrd
, 0);
903 CloseHandle (cp
->thrd
);
908 CloseHandle (cp
->char_avail
);
909 cp
->char_avail
= NULL
;
911 if (cp
->char_consumed
)
913 CloseHandle (cp
->char_consumed
);
914 cp
->char_consumed
= NULL
;
917 /* update child_proc_count (highest numbered slot in use plus one) */
918 if (cp
== child_procs
+ child_proc_count
- 1)
920 for (i
= child_proc_count
-1; i
>= 0; i
--)
921 if (CHILD_ACTIVE (&child_procs
[i
])
922 || child_procs
[i
].procinfo
.hProcess
!= NULL
)
924 child_proc_count
= i
+ 1;
929 child_proc_count
= 0;
932 /* Find a child by pid. */
933 static child_process
*
934 find_child_pid (DWORD pid
)
938 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
939 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
!= NULL
)
946 /* Thread proc for child process and socket reader threads. Each thread
947 is normally blocked until woken by select() to check for input by
948 reading one char. When the read completes, char_avail is signaled
949 to wake up the select emulator and the thread blocks itself again. */
951 reader_thread (void *arg
)
956 cp
= (child_process
*)arg
;
958 /* We have to wait for the go-ahead before we can start */
960 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
968 if (cp
->fd
>= 0 && fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
969 rc
= _sys_wait_accept (cp
->fd
);
971 rc
= _sys_read_ahead (cp
->fd
);
973 /* Don't bother waiting for the event if we already have been
974 told to exit by delete_child. */
975 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_avail
)
978 /* The name char_avail is a misnomer - it really just means the
979 read-ahead has completed, whether successfully or not. */
980 if (!SetEvent (cp
->char_avail
))
982 DebPrint (("reader_thread.SetEvent failed with %lu for fd %ld\n",
983 GetLastError (), cp
->fd
));
987 if (rc
== STATUS_READ_ERROR
)
990 /* If the read died, the child has died so let the thread die */
991 if (rc
== STATUS_READ_FAILED
)
994 /* Don't bother waiting for the acknowledge if we already have
995 been told to exit by delete_child. */
996 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_consumed
)
999 /* Wait until our input is acknowledged before reading again */
1000 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
1002 DebPrint (("reader_thread.WaitForSingleObject failed with "
1003 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
1006 /* delete_child sets status to STATUS_READ_ERROR when it wants
1008 if (cp
->status
== STATUS_READ_ERROR
)
1014 /* To avoid Emacs changing directory, we just record here the directory
1015 the new process should start in. This is set just before calling
1016 sys_spawnve, and is not generally valid at any other time. */
1017 static char * process_dir
;
1020 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
1021 int * pPid
, child_process
*cp
)
1024 SECURITY_ATTRIBUTES sec_attrs
;
1026 SECURITY_DESCRIPTOR sec_desc
;
1029 char dir
[ MAXPATHLEN
];
1031 if (cp
== NULL
) emacs_abort ();
1033 memset (&start
, 0, sizeof (start
));
1034 start
.cb
= sizeof (start
);
1037 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1038 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1040 start
.dwFlags
= STARTF_USESTDHANDLES
;
1041 start
.wShowWindow
= SW_HIDE
;
1043 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1044 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1045 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1046 #endif /* HAVE_NTGUI */
1049 /* Explicitly specify no security */
1050 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1052 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1055 sec_attrs
.nLength
= sizeof (sec_attrs
);
1056 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1057 sec_attrs
.bInheritHandle
= FALSE
;
1059 strcpy (dir
, process_dir
);
1060 unixtodos_filename (dir
);
1062 flags
= (!NILP (Vw32_start_process_share_console
)
1063 ? CREATE_NEW_PROCESS_GROUP
1064 : CREATE_NEW_CONSOLE
);
1065 if (NILP (Vw32_start_process_inherit_error_mode
))
1066 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1067 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1068 flags
, env
, dir
, &start
, &cp
->procinfo
))
1071 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1073 /* Hack for Windows 95, which assigns large (ie negative) pids */
1082 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1086 /* create_child doesn't know what emacs' file handle will be for waiting
1087 on output from the child, so we need to make this additional call
1088 to register the handle with the process
1089 This way the select emulator knows how to match file handles with
1090 entries in child_procs. */
1092 register_child (pid_t pid
, int fd
)
1096 cp
= find_child_pid ((DWORD
)pid
);
1099 DebPrint (("register_child unable to find pid %lu\n", pid
));
1104 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1109 /* thread is initially blocked until select is called; set status so
1110 that select will release thread */
1111 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1113 /* attach child_process to fd_info */
1114 if (fd_info
[fd
].cp
!= NULL
)
1116 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1120 fd_info
[fd
].cp
= cp
;
1123 /* Record INFILE as an input file for process PID. */
1125 record_infile (pid_t pid
, char *infile
)
1129 /* INFILE should never be NULL, since xstrdup would have signaled
1130 memory full condition in that case, see callproc.c where this
1131 function is called. */
1134 cp
= find_child_pid ((DWORD
)pid
);
1137 DebPrint (("record_infile is unable to find pid %lu\n", pid
));
1141 cp
->input_file
= infile
;
1144 /* Mark the input file INFILE of the corresponding subprocess as
1145 temporary, to be deleted when the subprocess exits. */
1147 record_pending_deletion (char *infile
)
1153 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1154 if (CHILD_ACTIVE (cp
)
1155 && cp
->input_file
&& xstrcasecmp (cp
->input_file
, infile
) == 0)
1157 cp
->pending_deletion
= 1;
1162 /* Called from waitpid when a process exits. */
1164 reap_subprocess (child_process
*cp
)
1166 if (cp
->procinfo
.hProcess
)
1168 /* Reap the process */
1170 /* Process should have already died before we are called. */
1171 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1172 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp
->fd
));
1174 CloseHandle (cp
->procinfo
.hProcess
);
1175 cp
->procinfo
.hProcess
= NULL
;
1176 CloseHandle (cp
->procinfo
.hThread
);
1177 cp
->procinfo
.hThread
= NULL
;
1180 /* If cp->fd was not closed yet, we might be still reading the
1181 process output, so don't free its resources just yet. The call
1182 to delete_child on behalf of this subprocess will be made by
1183 sys_read when the subprocess output is fully read. */
1188 /* Wait for a child process specified by PID, or for any of our
1189 existing child processes (if PID is nonpositive) to die. When it
1190 does, close its handle. Return the pid of the process that died
1191 and fill in STATUS if non-NULL. */
1194 waitpid (pid_t pid
, int *status
, int options
)
1196 DWORD active
, retval
;
1198 child_process
*cp
, *cps
[MAX_CHILDREN
];
1199 HANDLE wait_hnd
[MAX_CHILDREN
];
1201 int dont_wait
= (options
& WNOHANG
) != 0;
1204 /* According to Posix:
1206 PID = -1 means status is requested for any child process.
1208 PID > 0 means status is requested for a single child process
1211 PID = 0 means status is requested for any child process whose
1212 process group ID is equal to that of the calling process. But
1213 since Windows has only a limited support for process groups (only
1214 for console processes and only for the purposes of passing
1215 Ctrl-BREAK signal to them), and since we have no documented way
1216 of determining whether a given process belongs to our group, we
1219 PID < -1 means status is requested for any child process whose
1220 process group ID is equal to the absolute value of PID. Again,
1221 since we don't support process groups, we treat that as -1. */
1226 /* We are requested to wait for a specific child. */
1227 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1229 /* Some child_procs might be sockets; ignore them. Also
1230 ignore subprocesses whose output is not yet completely
1232 if (CHILD_ACTIVE (cp
)
1233 && cp
->procinfo
.hProcess
1242 if (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1244 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1250 /* PID specifies our subprocess, but its status is not
1257 /* No such child process, or nothing to wait for, so fail. */
1264 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1266 if (CHILD_ACTIVE (cp
)
1267 && cp
->procinfo
.hProcess
1268 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1270 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1277 /* Nothing to wait on, so fail. */
1286 timeout_ms
= 1000; /* check for quit about once a second. */
1291 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, timeout_ms
);
1292 } while (active
== WAIT_TIMEOUT
&& !dont_wait
);
1294 if (active
== WAIT_FAILED
)
1299 else if (active
== WAIT_TIMEOUT
&& dont_wait
)
1301 /* PID specifies our subprocess, but it didn't exit yet, so its
1302 status is not yet available. */
1304 DebPrint (("Wait: PID %d not reap yet\n", cp
->pid
));
1308 else if (active
>= WAIT_OBJECT_0
1309 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1311 active
-= WAIT_OBJECT_0
;
1313 else if (active
>= WAIT_ABANDONED_0
1314 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1316 active
-= WAIT_ABANDONED_0
;
1321 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1323 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1327 if (retval
== STILL_ACTIVE
)
1329 /* Should never happen. */
1330 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1331 if (pid
> 0 && dont_wait
)
1337 /* Massage the exit code from the process to match the format expected
1338 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1339 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1341 if (retval
== STATUS_CONTROL_C_EXIT
)
1346 if (pid
> 0 && active
!= 0)
1351 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1356 reap_subprocess (cp
);
1361 /* Old versions of w32api headers don't have separate 32-bit and
1362 64-bit defines, but the one they have matches the 32-bit variety. */
1363 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1364 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1365 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1369 w32_executable_type (char * filename
,
1371 int * is_cygnus_app
,
1374 file_data executable
;
1377 /* Default values in case we can't tell for sure. */
1378 *is_dos_app
= FALSE
;
1379 *is_cygnus_app
= FALSE
;
1380 *is_gui_app
= FALSE
;
1382 if (!open_input_file (&executable
, filename
))
1385 p
= strrchr (filename
, '.');
1387 /* We can only identify DOS .com programs from the extension. */
1388 if (p
&& xstrcasecmp (p
, ".com") == 0)
1390 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1391 || xstrcasecmp (p
, ".cmd") == 0))
1393 /* A DOS shell script - it appears that CreateProcess is happy to
1394 accept this (somewhat surprisingly); presumably it looks at
1395 COMSPEC to determine what executable to actually invoke.
1396 Therefore, we have to do the same here as well. */
1397 /* Actually, I think it uses the program association for that
1398 extension, which is defined in the registry. */
1399 p
= egetenv ("COMSPEC");
1401 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
1405 /* Look for DOS .exe signature - if found, we must also check that
1406 it isn't really a 16- or 32-bit Windows exe, since both formats
1407 start with a DOS program stub. Note that 16-bit Windows
1408 executables use the OS/2 1.x format. */
1410 IMAGE_DOS_HEADER
* dos_header
;
1411 IMAGE_NT_HEADERS
* nt_header
;
1413 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1414 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1417 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1419 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1421 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1424 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1425 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1429 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1431 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1432 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1434 /* Ensure we are using the 32 bit structure. */
1435 IMAGE_OPTIONAL_HEADER32
*opt
1436 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1437 data_dir
= opt
->DataDirectory
;
1438 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1440 /* MingW 3.12 has the required 64 bit structs, but in case older
1441 versions don't, only check 64 bit exes if we know how. */
1442 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1443 else if (nt_header
->OptionalHeader
.Magic
1444 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1446 IMAGE_OPTIONAL_HEADER64
*opt
1447 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1448 data_dir
= opt
->DataDirectory
;
1449 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1454 /* Look for cygwin.dll in DLL import list. */
1455 IMAGE_DATA_DIRECTORY import_dir
=
1456 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1457 IMAGE_IMPORT_DESCRIPTOR
* imports
;
1458 IMAGE_SECTION_HEADER
* section
;
1460 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
1461 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
1464 for ( ; imports
->Name
; imports
++)
1466 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1469 /* The exact name of the cygwin dll has changed with
1470 various releases, but hopefully this will be reasonably
1472 if (strncmp (dllname
, "cygwin", 6) == 0)
1474 *is_cygnus_app
= TRUE
;
1483 close_file_data (&executable
);
1487 compare_env (const void *strp1
, const void *strp2
)
1489 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1491 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1493 /* Sort order in command.com/cmd.exe is based on uppercasing
1494 names, so do the same here. */
1495 if (toupper (*str1
) > toupper (*str2
))
1497 else if (toupper (*str1
) < toupper (*str2
))
1502 if (*str1
== '=' && *str2
== '=')
1504 else if (*str1
== '=')
1511 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1513 char **optr
, **nptr
;
1525 num
+= optr
- envp2
;
1527 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1532 /* When a new child process is created we need to register it in our list,
1533 so intercept spawn requests. */
1535 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1537 Lisp_Object program
, full
;
1538 char *cmdline
, *env
, *parg
, **targ
;
1542 int is_dos_app
, is_cygnus_app
, is_gui_app
;
1545 /* We pass our process ID to our children by setting up an environment
1546 variable in their environment. */
1547 char ppid_env_var_buffer
[64];
1548 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1549 /* These are the characters that cause an argument to need quoting.
1550 Arguments with whitespace characters need quoting to prevent the
1551 argument being split into two or more. Arguments with wildcards
1552 are also quoted, for consistency with posix platforms, where wildcards
1553 are not expanded if we run the program directly without a shell.
1554 Some extra whitespace characters need quoting in Cygwin programs,
1555 so this list is conditionally modified below. */
1556 char *sepchars
= " \t*?";
1558 /* We don't care about the other modes */
1559 if (mode
!= _P_NOWAIT
)
1565 /* Handle executable names without an executable suffix. */
1566 program
= build_string (cmdname
);
1567 if (NILP (Ffile_executable_p (program
)))
1569 struct gcpro gcpro1
;
1573 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
1583 /* make sure argv[0] and cmdname are both in DOS format */
1584 cmdname
= SDATA (program
);
1585 unixtodos_filename (cmdname
);
1588 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1589 executable that is implicitly linked to the Cygnus dll (implying it
1590 was compiled with the Cygnus GNU toolchain and hence relies on
1591 cygwin.dll to parse the command line - we use this to decide how to
1592 escape quote chars in command line args that must be quoted).
1594 Also determine whether it is a GUI app, so that we don't hide its
1595 initial window unless specifically requested. */
1596 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
1598 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1599 application to start it by specifying the helper app as cmdname,
1600 while leaving the real app name as argv[0]. */
1603 cmdname
= alloca (MAXPATHLEN
);
1604 if (egetenv ("CMDPROXY"))
1605 strcpy (cmdname
, egetenv ("CMDPROXY"));
1608 strcpy (cmdname
, SDATA (Vinvocation_directory
));
1609 strcat (cmdname
, "cmdproxy.exe");
1611 unixtodos_filename (cmdname
);
1614 /* we have to do some conjuring here to put argv and envp into the
1615 form CreateProcess wants... argv needs to be a space separated/null
1616 terminated list of parameters, and envp is a null
1617 separated/double-null terminated list of parameters.
1619 Additionally, zero-length args and args containing whitespace or
1620 quote chars need to be wrapped in double quotes - for this to work,
1621 embedded quotes need to be escaped as well. The aim is to ensure
1622 the child process reconstructs the argv array we start with
1623 exactly, so we treat quotes at the beginning and end of arguments
1626 The w32 GNU-based library from Cygnus doubles quotes to escape
1627 them, while MSVC uses backslash for escaping. (Actually the MSVC
1628 startup code does attempt to recognize doubled quotes and accept
1629 them, but gets it wrong and ends up requiring three quotes to get a
1630 single embedded quote!) So by default we decide whether to use
1631 quote or backslash as the escape character based on whether the
1632 binary is apparently a Cygnus compiled app.
1634 Note that using backslash to escape embedded quotes requires
1635 additional special handling if an embedded quote is already
1636 preceded by backslash, or if an arg requiring quoting ends with
1637 backslash. In such cases, the run of escape characters needs to be
1638 doubled. For consistency, we apply this special handling as long
1639 as the escape character is not quote.
1641 Since we have no idea how large argv and envp are likely to be we
1642 figure out list lengths on the fly and allocate them. */
1644 if (!NILP (Vw32_quote_process_args
))
1647 /* Override escape char by binding w32-quote-process-args to
1648 desired character, or use t for auto-selection. */
1649 if (INTEGERP (Vw32_quote_process_args
))
1650 escape_char
= XINT (Vw32_quote_process_args
);
1652 escape_char
= is_cygnus_app
? '"' : '\\';
1655 /* Cygwin apps needs quoting a bit more often. */
1656 if (escape_char
== '"')
1657 sepchars
= "\r\n\t\f '";
1665 int need_quotes
= 0;
1666 int escape_char_run
= 0;
1672 if (escape_char
== '"' && *p
== '\\')
1673 /* If it's a Cygwin app, \ needs to be escaped. */
1677 /* allow for embedded quotes to be escaped */
1680 /* handle the case where the embedded quote is already escaped */
1681 if (escape_char_run
> 0)
1683 /* To preserve the arg exactly, we need to double the
1684 preceding escape characters (plus adding one to
1685 escape the quote character itself). */
1686 arglen
+= escape_char_run
;
1689 else if (strchr (sepchars
, *p
) != NULL
)
1694 if (*p
== escape_char
&& escape_char
!= '"')
1697 escape_char_run
= 0;
1702 /* handle the case where the arg ends with an escape char - we
1703 must not let the enclosing quote be escaped. */
1704 if (escape_char_run
> 0)
1705 arglen
+= escape_char_run
;
1707 arglen
+= strlen (*targ
++) + 1;
1709 cmdline
= alloca (arglen
);
1715 int need_quotes
= 0;
1723 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1728 int escape_char_run
= 0;
1734 last
= p
+ strlen (p
) - 1;
1737 /* This version does not escape quotes if they occur at the
1738 beginning or end of the arg - this could lead to incorrect
1739 behavior when the arg itself represents a command line
1740 containing quoted args. I believe this was originally done
1741 as a hack to make some things work, before
1742 `w32-quote-process-args' was added. */
1745 if (*p
== '"' && p
> first
&& p
< last
)
1746 *parg
++ = escape_char
; /* escape embedded quotes */
1754 /* double preceding escape chars if any */
1755 while (escape_char_run
> 0)
1757 *parg
++ = escape_char
;
1760 /* escape all quote chars, even at beginning or end */
1761 *parg
++ = escape_char
;
1763 else if (escape_char
== '"' && *p
== '\\')
1767 if (*p
== escape_char
&& escape_char
!= '"')
1770 escape_char_run
= 0;
1772 /* double escape chars before enclosing quote */
1773 while (escape_char_run
> 0)
1775 *parg
++ = escape_char
;
1783 strcpy (parg
, *targ
);
1784 parg
+= strlen (*targ
);
1794 numenv
= 1; /* for end null */
1797 arglen
+= strlen (*targ
++) + 1;
1800 /* extra env vars... */
1801 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
1802 GetCurrentProcessId ());
1803 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1806 /* merge env passed in and extra env into one, and sort it. */
1807 targ
= (char **) alloca (numenv
* sizeof (char *));
1808 merge_and_sort_env (envp
, extra_env
, targ
);
1810 /* concatenate env entries. */
1811 env
= alloca (arglen
);
1815 strcpy (parg
, *targ
);
1816 parg
+= strlen (*targ
++);
1829 /* Now create the process. */
1830 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1840 /* Emulate the select call
1841 Wait for available input on any of the given rfds, or timeout if
1842 a timeout is given and no input is detected
1843 wfds and efds are not supported and must be NULL.
1845 For simplicity, we detect the death of child processes here and
1846 synchronously call the SIGCHLD handler. Since it is possible for
1847 children to be created without a corresponding pipe handle from which
1848 to read output, we wait separately on the process handles as well as
1849 the char_avail events for each process pipe. We only call
1850 wait/reap_process when the process actually terminates.
1852 To reduce the number of places in which Emacs can be hung such that
1853 C-g is not able to interrupt it, we always wait on interrupt_handle
1854 (which is signaled by the input thread when C-g is detected). If we
1855 detect that we were woken up by C-g, we return -1 with errno set to
1856 EINTR as on Unix. */
1858 /* From w32console.c */
1859 extern HANDLE keyboard_handle
;
1861 /* From w32xfns.c */
1862 extern HANDLE interrupt_handle
;
1864 /* From process.c */
1865 extern int proc_buffered_char
[];
1868 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1869 EMACS_TIME
*timeout
, void *ignored
)
1872 DWORD timeout_ms
, start_time
;
1875 child_process
*cp
, *cps
[MAX_CHILDREN
];
1876 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1877 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1880 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
1882 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1883 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1889 /* Otherwise, we only handle rfds, so fail otherwise. */
1890 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1900 /* Always wait on interrupt_handle, to detect C-g (quit). */
1901 wait_hnd
[0] = interrupt_handle
;
1904 /* Build a list of pipe handles to wait on. */
1906 for (i
= 0; i
< nfds
; i
++)
1907 if (FD_ISSET (i
, &orfds
))
1911 if (keyboard_handle
)
1913 /* Handle stdin specially */
1914 wait_hnd
[nh
] = keyboard_handle
;
1919 /* Check for any emacs-generated input in the queue since
1920 it won't be detected in the wait */
1921 if (detect_input_pending ())
1929 /* Child process and socket/comm port input. */
1933 int current_status
= cp
->status
;
1935 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1937 /* Tell reader thread which file handle to use. */
1939 /* Wake up the reader thread for this process */
1940 cp
->status
= STATUS_READ_READY
;
1941 if (!SetEvent (cp
->char_consumed
))
1942 DebPrint (("sys_select.SetEvent failed with "
1943 "%lu for fd %ld\n", GetLastError (), i
));
1946 #ifdef CHECK_INTERLOCK
1947 /* slightly crude cross-checking of interlock between threads */
1949 current_status
= cp
->status
;
1950 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1952 /* char_avail has been signaled, so status (which may
1953 have changed) should indicate read has completed
1954 but has not been acknowledged. */
1955 current_status
= cp
->status
;
1956 if (current_status
!= STATUS_READ_SUCCEEDED
1957 && current_status
!= STATUS_READ_FAILED
)
1958 DebPrint (("char_avail set, but read not completed: status %d\n",
1963 /* char_avail has not been signaled, so status should
1964 indicate that read is in progress; small possibility
1965 that read has completed but event wasn't yet signaled
1966 when we tested it (because a context switch occurred
1967 or if running on separate CPUs). */
1968 if (current_status
!= STATUS_READ_READY
1969 && current_status
!= STATUS_READ_IN_PROGRESS
1970 && current_status
!= STATUS_READ_SUCCEEDED
1971 && current_status
!= STATUS_READ_FAILED
)
1972 DebPrint (("char_avail reset, but read status is bad: %d\n",
1976 wait_hnd
[nh
] = cp
->char_avail
;
1978 if (!wait_hnd
[nh
]) emacs_abort ();
1981 DebPrint (("select waiting on child %d fd %d\n",
1982 cp
-child_procs
, i
));
1987 /* Unable to find something to wait on for this fd, skip */
1989 /* Note that this is not a fatal error, and can in fact
1990 happen in unusual circumstances. Specifically, if
1991 sys_spawnve fails, eg. because the program doesn't
1992 exist, and debug-on-error is t so Fsignal invokes a
1993 nested input loop, then the process output pipe is
1994 still included in input_wait_mask with no child_proc
1995 associated with it. (It is removed when the debugger
1996 exits the nested input loop and the error is thrown.) */
1998 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
2004 /* Add handles of child processes. */
2006 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
2007 /* Some child_procs might be sockets; ignore them. Also some
2008 children may have died already, but we haven't finished reading
2009 the process output; ignore them too. */
2010 if (CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
2012 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
2013 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
2016 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
2021 /* Nothing to look for, so we didn't find anything */
2029 start_time
= GetTickCount ();
2031 /* Wait for input or child death to be signaled. If user input is
2032 allowed, then also accept window messages. */
2033 if (FD_ISSET (0, &orfds
))
2034 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
2037 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
2039 if (active
== WAIT_FAILED
)
2041 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2042 nh
+ nc
, timeout_ms
, GetLastError ()));
2043 /* don't return EBADF - this causes wait_reading_process_output to
2044 abort; WAIT_FAILED is returned when single-stepping under
2045 Windows 95 after switching thread focus in debugger, and
2046 possibly at other times. */
2050 else if (active
== WAIT_TIMEOUT
)
2054 else if (active
>= WAIT_OBJECT_0
2055 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
2057 active
-= WAIT_OBJECT_0
;
2059 else if (active
>= WAIT_ABANDONED_0
2060 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
2062 active
-= WAIT_ABANDONED_0
;
2067 /* Loop over all handles after active (now officially documented as
2068 being the first signaled handle in the array). We do this to
2069 ensure fairness, so that all channels with data available will be
2070 processed - otherwise higher numbered channels could be starved. */
2073 if (active
== nh
+ nc
)
2075 /* There are messages in the lisp thread's queue; we must
2076 drain the queue now to ensure they are processed promptly,
2077 because if we don't do so, we will not be woken again until
2078 further messages arrive.
2080 NB. If ever we allow window message procedures to callback
2081 into lisp, we will need to ensure messages are dispatched
2082 at a safe time for lisp code to be run (*), and we may also
2083 want to provide some hooks in the dispatch loop to cater
2084 for modeless dialogs created by lisp (ie. to register
2085 window handles to pass to IsDialogMessage).
2087 (*) Note that MsgWaitForMultipleObjects above is an
2088 internal dispatch point for messages that are sent to
2089 windows created by this thread. */
2090 if (drain_message_queue ()
2091 /* If drain_message_queue returns non-zero, that means
2092 we received a WM_EMACS_FILENOTIFY message. If this
2093 is a TTY frame, we must signal the caller that keyboard
2094 input is available, so that w32_console_read_socket
2095 will be called to pick up the notifications. If we
2096 don't do that, file notifications will only work when
2097 the Emacs TTY frame has focus. */
2098 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2099 /* they asked for stdin reads */
2100 && FD_ISSET (0, &orfds
)
2101 /* the stdin handle is valid */
2109 else if (active
>= nh
)
2111 cp
= cps
[active
- nh
];
2113 /* We cannot always signal SIGCHLD immediately; if we have not
2114 finished reading the process output, we must delay sending
2115 SIGCHLD until we do. */
2117 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
2118 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
2119 /* SIG_DFL for SIGCHLD is ignore */
2120 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2121 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2124 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2127 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2130 else if (fdindex
[active
] == -1)
2132 /* Quit (C-g) was detected. */
2136 else if (fdindex
[active
] == 0)
2138 /* Keyboard input available */
2144 /* must be a socket or pipe - read ahead should have
2145 completed, either succeeding or failing. */
2146 FD_SET (fdindex
[active
], rfds
);
2150 /* Even though wait_reading_process_output only reads from at most
2151 one channel, we must process all channels here so that we reap
2152 all children that have died. */
2153 while (++active
< nh
+ nc
)
2154 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2156 } while (active
< nh
+ nc
);
2158 /* If no input has arrived and timeout hasn't expired, wait again. */
2161 DWORD elapsed
= GetTickCount () - start_time
;
2163 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2165 if (timeout_ms
!= INFINITE
)
2166 timeout_ms
-= elapsed
;
2167 goto count_children
;
2174 /* Substitute for certain kill () operations */
2176 static BOOL CALLBACK
2177 find_child_console (HWND hwnd
, LPARAM arg
)
2179 child_process
* cp
= (child_process
*) arg
;
2183 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
2184 if (process_id
== cp
->procinfo
.dwProcessId
)
2186 char window_class
[32];
2188 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2189 if (strcmp (window_class
,
2190 (os_subtype
== OS_9X
)
2192 : "ConsoleWindowClass") == 0)
2202 /* Emulate 'kill', but only for other processes. */
2204 sys_kill (pid_t pid
, int sig
)
2208 int need_to_free
= 0;
2211 /* Each process is in its own process group. */
2215 /* Only handle signals that will result in the process dying */
2216 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
2222 cp
= find_child_pid (pid
);
2225 /* We were passed a PID of something other than our subprocess.
2226 If that is our own PID, we will send to ourself a message to
2227 close the selected frame, which does not necessarily
2228 terminates Emacs. But then we are not supposed to call
2229 sys_kill with our own PID. */
2230 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
2231 if (proc_hand
== NULL
)
2240 proc_hand
= cp
->procinfo
.hProcess
;
2241 pid
= cp
->procinfo
.dwProcessId
;
2243 /* Try to locate console window for process. */
2244 EnumWindows (find_child_console
, (LPARAM
) cp
);
2247 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2249 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2251 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2252 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2253 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2254 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2255 HWND foreground_window
;
2257 if (break_scan_code
== 0)
2259 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2260 vk_break_code
= 'C';
2261 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2264 foreground_window
= GetForegroundWindow ();
2265 if (foreground_window
)
2267 /* NT 5.0, and apparently also Windows 98, will not allow
2268 a Window to be set to foreground directly without the
2269 user's involvement. The workaround is to attach
2270 ourselves to the thread that owns the foreground
2271 window, since that is the only thread that can set the
2272 foreground window. */
2273 DWORD foreground_thread
, child_thread
;
2275 GetWindowThreadProcessId (foreground_window
, NULL
);
2276 if (foreground_thread
== GetCurrentThreadId ()
2277 || !AttachThreadInput (GetCurrentThreadId (),
2278 foreground_thread
, TRUE
))
2279 foreground_thread
= 0;
2281 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2282 if (child_thread
== GetCurrentThreadId ()
2283 || !AttachThreadInput (GetCurrentThreadId (),
2284 child_thread
, TRUE
))
2287 /* Set the foreground window to the child. */
2288 if (SetForegroundWindow (cp
->hwnd
))
2290 /* Generate keystrokes as if user had typed Ctrl-Break or
2292 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2293 keybd_event (vk_break_code
, break_scan_code
,
2294 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2295 keybd_event (vk_break_code
, break_scan_code
,
2296 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2297 | KEYEVENTF_KEYUP
, 0);
2298 keybd_event (VK_CONTROL
, control_scan_code
,
2299 KEYEVENTF_KEYUP
, 0);
2301 /* Sleep for a bit to give time for Emacs frame to respond
2302 to focus change events (if Emacs was active app). */
2305 SetForegroundWindow (foreground_window
);
2307 /* Detach from the foreground and child threads now that
2308 the foreground switching is over. */
2309 if (foreground_thread
)
2310 AttachThreadInput (GetCurrentThreadId (),
2311 foreground_thread
, FALSE
);
2313 AttachThreadInput (GetCurrentThreadId (),
2314 child_thread
, FALSE
);
2317 /* Ctrl-Break is NT equivalent of SIGINT. */
2318 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2320 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2321 "for pid %lu\n", GetLastError (), pid
));
2328 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2331 if (os_subtype
== OS_9X
)
2334 Another possibility is to try terminating the VDM out-right by
2335 calling the Shell VxD (id 0x17) V86 interface, function #4
2336 "SHELL_Destroy_VM", ie.
2342 First need to determine the current VM handle, and then arrange for
2343 the shellapi call to be made from the system vm (by using
2344 Switch_VM_and_callback).
2346 Could try to invoke DestroyVM through CallVxD.
2350 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2351 to hang when cmdproxy is used in conjunction with
2352 command.com for an interactive shell. Posting
2353 WM_CLOSE pops up a dialog that, when Yes is selected,
2354 does the same thing. TerminateProcess is also less
2355 than ideal in that subprocesses tend to stick around
2356 until the machine is shutdown, but at least it
2357 doesn't freeze the 16-bit subsystem. */
2358 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2360 if (!TerminateProcess (proc_hand
, 0xff))
2362 DebPrint (("sys_kill.TerminateProcess returned %d "
2363 "for pid %lu\n", GetLastError (), pid
));
2370 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2372 /* Kill the process. On W32 this doesn't kill child processes
2373 so it doesn't work very well for shells which is why it's not
2374 used in every case. */
2375 else if (!TerminateProcess (proc_hand
, 0xff))
2377 DebPrint (("sys_kill.TerminateProcess returned %d "
2378 "for pid %lu\n", GetLastError (), pid
));
2385 CloseHandle (proc_hand
);
2390 /* The following two routines are used to manipulate stdin, stdout, and
2391 stderr of our child processes.
2393 Assuming that in, out, and err are *not* inheritable, we make them
2394 stdin, stdout, and stderr of the child as follows:
2396 - Save the parent's current standard handles.
2397 - Set the std handles to inheritable duplicates of the ones being passed in.
2398 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2399 NT file handle for a crt file descriptor.)
2400 - Spawn the child, which inherits in, out, and err as stdin,
2401 stdout, and stderr. (see Spawnve)
2402 - Close the std handles passed to the child.
2403 - Reset the parent's standard handles to the saved handles.
2404 (see reset_standard_handles)
2405 We assume that the caller closes in, out, and err after calling us. */
2408 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2411 HANDLE newstdin
, newstdout
, newstderr
;
2413 parent
= GetCurrentProcess ();
2415 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2416 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2417 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2419 /* make inheritable copies of the new handles */
2420 if (!DuplicateHandle (parent
,
2421 (HANDLE
) _get_osfhandle (in
),
2426 DUPLICATE_SAME_ACCESS
))
2427 report_file_error ("Duplicating input handle for child", Qnil
);
2429 if (!DuplicateHandle (parent
,
2430 (HANDLE
) _get_osfhandle (out
),
2435 DUPLICATE_SAME_ACCESS
))
2436 report_file_error ("Duplicating output handle for child", Qnil
);
2438 if (!DuplicateHandle (parent
,
2439 (HANDLE
) _get_osfhandle (err
),
2444 DUPLICATE_SAME_ACCESS
))
2445 report_file_error ("Duplicating error handle for child", Qnil
);
2447 /* and store them as our std handles */
2448 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2449 report_file_error ("Changing stdin handle", Qnil
);
2451 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2452 report_file_error ("Changing stdout handle", Qnil
);
2454 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2455 report_file_error ("Changing stderr handle", Qnil
);
2459 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2461 /* close the duplicated handles passed to the child */
2462 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2463 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2464 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2466 /* now restore parent's saved std handles */
2467 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2468 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2469 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2473 set_process_dir (char * dir
)
2478 /* To avoid problems with winsock implementations that work over dial-up
2479 connections causing or requiring a connection to exist while Emacs is
2480 running, Emacs no longer automatically loads winsock on startup if it
2481 is present. Instead, it will be loaded when open-network-stream is
2484 To allow full control over when winsock is loaded, we provide these
2485 two functions to dynamically load and unload winsock. This allows
2486 dial-up users to only be connected when they actually need to use
2490 extern HANDLE winsock_lib
;
2491 extern BOOL
term_winsock (void);
2492 extern BOOL
init_winsock (int load_now
);
2494 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2495 doc
: /* Test for presence of the Windows socket library `winsock'.
2496 Returns non-nil if winsock support is present, nil otherwise.
2498 If the optional argument LOAD-NOW is non-nil, the winsock library is
2499 also loaded immediately if not already loaded. If winsock is loaded,
2500 the winsock local hostname is returned (since this may be different from
2501 the value of `system-name' and should supplant it), otherwise t is
2502 returned to indicate winsock support is present. */)
2503 (Lisp_Object load_now
)
2507 have_winsock
= init_winsock (!NILP (load_now
));
2510 if (winsock_lib
!= NULL
)
2512 /* Return new value for system-name. The best way to do this
2513 is to call init_system_name, saving and restoring the
2514 original value to avoid side-effects. */
2515 Lisp_Object orig_hostname
= Vsystem_name
;
2516 Lisp_Object hostname
;
2518 init_system_name ();
2519 hostname
= Vsystem_name
;
2520 Vsystem_name
= orig_hostname
;
2528 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2530 doc
: /* Unload the Windows socket library `winsock' if loaded.
2531 This is provided to allow dial-up socket connections to be disconnected
2532 when no longer needed. Returns nil without unloading winsock if any
2533 socket connections still exist. */)
2536 return term_winsock () ? Qt
: Qnil
;
2540 /* Some miscellaneous functions that are Windows specific, but not GUI
2541 specific (ie. are applicable in terminal or batch mode as well). */
2543 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2544 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2545 If FILENAME does not exist, return nil.
2546 All path elements in FILENAME are converted to their short names. */)
2547 (Lisp_Object filename
)
2549 char shortname
[MAX_PATH
];
2551 CHECK_STRING (filename
);
2553 /* first expand it. */
2554 filename
= Fexpand_file_name (filename
, Qnil
);
2556 /* luckily, this returns the short version of each element in the path. */
2557 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
2560 dostounix_filename (shortname
);
2562 return build_string (shortname
);
2566 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2568 doc
: /* Return the long file name version of the full path of FILENAME.
2569 If FILENAME does not exist, return nil.
2570 All path elements in FILENAME are converted to their long names. */)
2571 (Lisp_Object filename
)
2573 char longname
[ MAX_PATH
];
2576 CHECK_STRING (filename
);
2578 if (SBYTES (filename
) == 2
2579 && *(SDATA (filename
) + 1) == ':')
2582 /* first expand it. */
2583 filename
= Fexpand_file_name (filename
, Qnil
);
2585 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
2588 dostounix_filename (longname
);
2590 /* If we were passed only a drive, make sure that a slash is not appended
2591 for consistency with directories. Allow for drive mapping via SUBST
2592 in case expand-file-name is ever changed to expand those. */
2593 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2596 return DECODE_FILE (build_string (longname
));
2599 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2600 Sw32_set_process_priority
, 2, 2, 0,
2601 doc
: /* Set the priority of PROCESS to PRIORITY.
2602 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2603 priority of the process whose pid is PROCESS is changed.
2604 PRIORITY should be one of the symbols high, normal, or low;
2605 any other symbol will be interpreted as normal.
2607 If successful, the return value is t, otherwise nil. */)
2608 (Lisp_Object process
, Lisp_Object priority
)
2610 HANDLE proc_handle
= GetCurrentProcess ();
2611 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2612 Lisp_Object result
= Qnil
;
2614 CHECK_SYMBOL (priority
);
2616 if (!NILP (process
))
2621 CHECK_NUMBER (process
);
2623 /* Allow pid to be an internally generated one, or one obtained
2624 externally. This is necessary because real pids on Windows 95 are
2627 pid
= XINT (process
);
2628 cp
= find_child_pid (pid
);
2630 pid
= cp
->procinfo
.dwProcessId
;
2632 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
2635 if (EQ (priority
, Qhigh
))
2636 priority_class
= HIGH_PRIORITY_CLASS
;
2637 else if (EQ (priority
, Qlow
))
2638 priority_class
= IDLE_PRIORITY_CLASS
;
2640 if (proc_handle
!= NULL
)
2642 if (SetPriorityClass (proc_handle
, priority_class
))
2644 if (!NILP (process
))
2645 CloseHandle (proc_handle
);
2651 #ifdef HAVE_LANGINFO_CODESET
2652 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2654 nl_langinfo (nl_item item
)
2656 /* Conversion of Posix item numbers to their Windows equivalents. */
2657 static const LCTYPE w32item
[] = {
2658 LOCALE_IDEFAULTANSICODEPAGE
,
2659 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
2660 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
2661 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
2662 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
2663 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
2664 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
2667 static char *nl_langinfo_buf
= NULL
;
2668 static int nl_langinfo_len
= 0;
2670 if (nl_langinfo_len
<= 0)
2671 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
2673 if (item
< 0 || item
>= _NL_NUM
)
2674 nl_langinfo_buf
[0] = 0;
2677 LCID cloc
= GetThreadLocale ();
2678 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2682 nl_langinfo_buf
[0] = 0;
2685 if (item
== CODESET
)
2687 need_len
+= 2; /* for the "cp" prefix */
2688 if (need_len
< 8) /* for the case we call GetACP */
2691 if (nl_langinfo_len
<= need_len
)
2692 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
2693 nl_langinfo_len
= need_len
);
2694 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2695 nl_langinfo_buf
, nl_langinfo_len
))
2696 nl_langinfo_buf
[0] = 0;
2697 else if (item
== CODESET
)
2699 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
2700 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
2701 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
2704 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
2705 strlen (nl_langinfo_buf
) + 1);
2706 nl_langinfo_buf
[0] = 'c';
2707 nl_langinfo_buf
[1] = 'p';
2712 return nl_langinfo_buf
;
2714 #endif /* HAVE_LANGINFO_CODESET */
2716 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
2717 Sw32_get_locale_info
, 1, 2, 0,
2718 doc
: /* Return information about the Windows locale LCID.
2719 By default, return a three letter locale code which encodes the default
2720 language as the first two characters, and the country or regional variant
2721 as the third letter. For example, ENU refers to `English (United States)',
2722 while ENC means `English (Canadian)'.
2724 If the optional argument LONGFORM is t, the long form of the locale
2725 name is returned, e.g. `English (United States)' instead; if LONGFORM
2726 is a number, it is interpreted as an LCTYPE constant and the corresponding
2727 locale information is returned.
2729 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2730 (Lisp_Object lcid
, Lisp_Object longform
)
2734 char abbrev_name
[32] = { 0 };
2735 char full_name
[256] = { 0 };
2737 CHECK_NUMBER (lcid
);
2739 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2742 if (NILP (longform
))
2744 got_abbrev
= GetLocaleInfo (XINT (lcid
),
2745 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
2746 abbrev_name
, sizeof (abbrev_name
));
2748 return build_string (abbrev_name
);
2750 else if (EQ (longform
, Qt
))
2752 got_full
= GetLocaleInfo (XINT (lcid
),
2753 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
2754 full_name
, sizeof (full_name
));
2756 return DECODE_SYSTEM (build_string (full_name
));
2758 else if (NUMBERP (longform
))
2760 got_full
= GetLocaleInfo (XINT (lcid
),
2762 full_name
, sizeof (full_name
));
2763 /* GetLocaleInfo's return value includes the terminating null
2764 character, when the returned information is a string, whereas
2765 make_unibyte_string needs the string length without the
2766 terminating null. */
2768 return make_unibyte_string (full_name
, got_full
- 1);
2775 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
2776 Sw32_get_current_locale_id
, 0, 0, 0,
2777 doc
: /* Return Windows locale id for current locale setting.
2778 This is a numerical value; use `w32-get-locale-info' to convert to a
2779 human-readable form. */)
2782 return make_number (GetThreadLocale ());
2786 int_from_hex (char * s
)
2789 static char hex
[] = "0123456789abcdefABCDEF";
2792 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
2794 unsigned digit
= p
- hex
;
2797 val
= val
* 16 + digit
;
2803 /* We need to build a global list, since the EnumSystemLocale callback
2804 function isn't given a context pointer. */
2805 Lisp_Object Vw32_valid_locale_ids
;
2807 static BOOL CALLBACK
2808 enum_locale_fn (LPTSTR localeNum
)
2810 DWORD id
= int_from_hex (localeNum
);
2811 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2815 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2816 Sw32_get_valid_locale_ids
, 0, 0, 0,
2817 doc
: /* Return list of all valid Windows locale ids.
2818 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2819 human-readable form. */)
2822 Vw32_valid_locale_ids
= Qnil
;
2824 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2826 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2827 return Vw32_valid_locale_ids
;
2831 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2832 doc
: /* Return Windows locale id for default locale setting.
2833 By default, the system default locale setting is returned; if the optional
2834 parameter USERP is non-nil, the user default locale setting is returned.
2835 This is a numerical value; use `w32-get-locale-info' to convert to a
2836 human-readable form. */)
2840 return make_number (GetSystemDefaultLCID ());
2841 return make_number (GetUserDefaultLCID ());
2845 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2846 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2847 If successful, the new locale id is returned, otherwise nil. */)
2850 CHECK_NUMBER (lcid
);
2852 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2855 if (!SetThreadLocale (XINT (lcid
)))
2858 /* Need to set input thread locale if present. */
2859 if (dwWindowsThreadId
)
2860 /* Reply is not needed. */
2861 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2863 return make_number (GetThreadLocale ());
2867 /* We need to build a global list, since the EnumCodePages callback
2868 function isn't given a context pointer. */
2869 Lisp_Object Vw32_valid_codepages
;
2871 static BOOL CALLBACK
2872 enum_codepage_fn (LPTSTR codepageNum
)
2874 DWORD id
= atoi (codepageNum
);
2875 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2879 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2880 Sw32_get_valid_codepages
, 0, 0, 0,
2881 doc
: /* Return list of all valid Windows codepages. */)
2884 Vw32_valid_codepages
= Qnil
;
2886 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2888 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2889 return Vw32_valid_codepages
;
2893 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2894 Sw32_get_console_codepage
, 0, 0, 0,
2895 doc
: /* Return current Windows codepage for console input. */)
2898 return make_number (GetConsoleCP ());
2902 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2903 Sw32_set_console_codepage
, 1, 1, 0,
2904 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2905 This codepage setting affects keyboard input in tty mode.
2906 If successful, the new CP is returned, otherwise nil. */)
2911 if (!IsValidCodePage (XINT (cp
)))
2914 if (!SetConsoleCP (XINT (cp
)))
2917 return make_number (GetConsoleCP ());
2921 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2922 Sw32_get_console_output_codepage
, 0, 0, 0,
2923 doc
: /* Return current Windows codepage for console output. */)
2926 return make_number (GetConsoleOutputCP ());
2930 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2931 Sw32_set_console_output_codepage
, 1, 1, 0,
2932 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
2933 This codepage setting affects display in tty mode.
2934 If successful, the new CP is returned, otherwise nil. */)
2939 if (!IsValidCodePage (XINT (cp
)))
2942 if (!SetConsoleOutputCP (XINT (cp
)))
2945 return make_number (GetConsoleOutputCP ());
2949 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2950 Sw32_get_codepage_charset
, 1, 1, 0,
2951 doc
: /* Return charset ID corresponding to codepage CP.
2952 Returns nil if the codepage is not valid. */)
2959 if (!IsValidCodePage (XINT (cp
)))
2962 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
2963 return make_number (info
.ciCharset
);
2969 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
2970 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
2971 doc
: /* Return list of Windows keyboard languages and layouts.
2972 The return value is a list of pairs of language id and layout id. */)
2975 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
2976 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
2977 Lisp_Object obj
= Qnil
;
2979 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
2981 while (--num_layouts
>= 0)
2983 DWORD kl
= (DWORD
) layouts
[num_layouts
];
2985 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
2986 make_number ((kl
>> 16) & 0xffff)),
2995 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
2996 Sw32_get_keyboard_layout
, 0, 0, 0,
2997 doc
: /* Return current Windows keyboard language and layout.
2998 The return value is the cons of the language id and the layout id. */)
3001 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
3003 return Fcons (make_number (kl
& 0xffff),
3004 make_number ((kl
>> 16) & 0xffff));
3008 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
3009 Sw32_set_keyboard_layout
, 1, 1, 0,
3010 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
3011 The keyboard layout setting affects interpretation of keyboard input.
3012 If successful, the new layout id is returned, otherwise nil. */)
3013 (Lisp_Object layout
)
3017 CHECK_CONS (layout
);
3018 CHECK_NUMBER_CAR (layout
);
3019 CHECK_NUMBER_CDR (layout
);
3021 kl
= (XINT (XCAR (layout
)) & 0xffff)
3022 | (XINT (XCDR (layout
)) << 16);
3024 /* Synchronize layout with input thread. */
3025 if (dwWindowsThreadId
)
3027 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
3031 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
3033 if (msg
.wParam
== 0)
3037 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
3040 return Fw32_get_keyboard_layout ();
3045 syms_of_ntproc (void)
3047 DEFSYM (Qhigh
, "high");
3048 DEFSYM (Qlow
, "low");
3050 defsubr (&Sw32_has_winsock
);
3051 defsubr (&Sw32_unload_winsock
);
3053 defsubr (&Sw32_short_file_name
);
3054 defsubr (&Sw32_long_file_name
);
3055 defsubr (&Sw32_set_process_priority
);
3056 defsubr (&Sw32_get_locale_info
);
3057 defsubr (&Sw32_get_current_locale_id
);
3058 defsubr (&Sw32_get_default_locale_id
);
3059 defsubr (&Sw32_get_valid_locale_ids
);
3060 defsubr (&Sw32_set_current_locale
);
3062 defsubr (&Sw32_get_console_codepage
);
3063 defsubr (&Sw32_set_console_codepage
);
3064 defsubr (&Sw32_get_console_output_codepage
);
3065 defsubr (&Sw32_set_console_output_codepage
);
3066 defsubr (&Sw32_get_valid_codepages
);
3067 defsubr (&Sw32_get_codepage_charset
);
3069 defsubr (&Sw32_get_valid_keyboard_layouts
);
3070 defsubr (&Sw32_get_keyboard_layout
);
3071 defsubr (&Sw32_set_keyboard_layout
);
3073 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
3074 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3075 Because Windows does not directly pass argv arrays to child processes,
3076 programs have to reconstruct the argv array by parsing the command
3077 line string. For an argument to contain a space, it must be enclosed
3078 in double quotes or it will be parsed as multiple arguments.
3080 If the value is a character, that character will be used to escape any
3081 quote characters that appear, otherwise a suitable escape character
3082 will be chosen based on the type of the program. */);
3083 Vw32_quote_process_args
= Qt
;
3085 DEFVAR_LISP ("w32-start-process-show-window",
3086 Vw32_start_process_show_window
,
3087 doc
: /* When nil, new child processes hide their windows.
3088 When non-nil, they show their window in the method of their choice.
3089 This variable doesn't affect GUI applications, which will never be hidden. */);
3090 Vw32_start_process_show_window
= Qnil
;
3092 DEFVAR_LISP ("w32-start-process-share-console",
3093 Vw32_start_process_share_console
,
3094 doc
: /* When nil, new child processes are given a new console.
3095 When non-nil, they share the Emacs console; this has the limitation of
3096 allowing only one DOS subprocess to run at a time (whether started directly
3097 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3098 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3099 otherwise respond to interrupts from Emacs. */);
3100 Vw32_start_process_share_console
= Qnil
;
3102 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3103 Vw32_start_process_inherit_error_mode
,
3104 doc
: /* When nil, new child processes revert to the default error mode.
3105 When non-nil, they inherit their error mode setting from Emacs, which stops
3106 them blocking when trying to access unmounted drives etc. */);
3107 Vw32_start_process_inherit_error_mode
= Qt
;
3109 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
3110 doc
: /* Forced delay before reading subprocess output.
3111 This is done to improve the buffering of subprocess output, by
3112 avoiding the inefficiency of frequently reading small amounts of data.
3114 If positive, the value is the number of milliseconds to sleep before
3115 reading the subprocess output. If negative, the magnitude is the number
3116 of time slices to wait (effectively boosting the priority of the child
3117 process temporarily). A value of zero disables waiting entirely. */);
3118 w32_pipe_read_delay
= 50;
3120 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
3121 doc
: /* Non-nil means convert all-upper case file names to lower case.
3122 This applies when performing completions and file name expansion.
3123 Note that the value of this setting also affects remote file names,
3124 so you probably don't want to set to non-nil if you use case-sensitive
3125 filesystems via ange-ftp. */);
3126 Vw32_downcase_file_names
= Qnil
;
3129 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3130 doc
: /* Non-nil means attempt to fake realistic inode values.
3131 This works by hashing the truename of files, and should detect
3132 aliasing between long and short (8.3 DOS) names, but can have
3133 false positives because of hash collisions. Note that determining
3134 the truename of a file can be slow. */);
3135 Vw32_generate_fake_inodes
= Qnil
;
3138 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3139 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3140 This option controls whether to issue additional system calls to determine
3141 accurate link counts, file type, and ownership information. It is more
3142 useful for files on NTFS volumes, where hard links and file security are
3143 supported, than on volumes of the FAT family.
3145 Without these system calls, link count will always be reported as 1 and file
3146 ownership will be attributed to the current user.
3147 The default value `local' means only issue these system calls for files
3148 on local fixed drives. A value of nil means never issue them.
3149 Any other non-nil value means do this even on remote and removable drives
3150 where the performance impact may be noticeable even on modern hardware. */);
3151 Vw32_get_true_file_attributes
= Qlocal
;
3153 staticpro (&Vw32_valid_locale_ids
);
3154 staticpro (&Vw32_valid_codepages
);
3156 /* end of w32proc.c */