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
)
808 child_process
*dead_cp
= NULL
;
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
)
816 if (!GetExitCodeProcess (cp
->procinfo
.hProcess
, &status
))
818 DebPrint (("new_child.GetExitCodeProcess: error %lu for PID %lu\n",
819 GetLastError (), cp
->procinfo
.dwProcessId
));
820 status
= STILL_ACTIVE
;
822 if (status
!= STILL_ACTIVE
823 || WaitForSingleObject (cp
->procinfo
.hProcess
, 0) == WAIT_OBJECT_0
)
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. */
847 if (child_proc_count
== MAX_CHILDREN
)
849 cp
= &child_procs
[child_proc_count
++];
852 memset (cp
, 0, sizeof (*cp
));
855 cp
->procinfo
.hProcess
= NULL
;
856 cp
->status
= STATUS_READ_ERROR
;
857 cp
->input_file
= NULL
;
858 cp
->pending_deletion
= 0;
860 /* use manual reset event so that select() will function properly */
861 cp
->char_avail
= CreateEvent (NULL
, TRUE
, FALSE
, NULL
);
864 cp
->char_consumed
= CreateEvent (NULL
, FALSE
, FALSE
, NULL
);
865 if (cp
->char_consumed
)
867 /* The 0x00010000 flag is STACK_SIZE_PARAM_IS_A_RESERVATION.
868 It means that the 64K stack we are requesting in the 2nd
869 argument is how much memory should be reserved for the
870 stack. If we don't use this flag, the memory requested
871 by the 2nd argument is the amount actually _committed_,
872 but Windows reserves 8MB of memory for each thread's
873 stack. (The 8MB figure comes from the -stack
874 command-line argument we pass to the linker when building
875 Emacs, but that's because we need a large stack for
876 Emacs's main thread.) Since we request 2GB of reserved
877 memory at startup (see w32heap.c), which is close to the
878 maximum memory available for a 32-bit process on Windows,
879 the 8MB reservation for each thread causes failures in
880 starting subprocesses, because we create a thread running
881 reader_thread for each subprocess. As 8MB of stack is
882 way too much for reader_thread, forcing Windows to
883 reserve less wins the day. */
884 cp
->thrd
= CreateThread (NULL
, 64 * 1024, reader_thread
, cp
,
895 delete_child (child_process
*cp
)
899 /* Should not be deleting a child that is still needed. */
900 for (i
= 0; i
< MAXDESC
; i
++)
901 if (fd_info
[i
].cp
== cp
)
904 if (!CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
== NULL
)
907 /* Delete the child's temporary input file, if any, that is pending
911 if (cp
->pending_deletion
)
913 if (unlink (cp
->input_file
))
914 DebPrint (("delete_child.unlink (%s) failed, errno: %d\n",
915 cp
->input_file
, errno
));
916 cp
->pending_deletion
= 0;
918 xfree (cp
->input_file
);
919 cp
->input_file
= NULL
;
922 /* reap thread if necessary */
927 if (GetExitCodeThread (cp
->thrd
, &rc
) && rc
== STILL_ACTIVE
)
929 /* let the thread exit cleanly if possible */
930 cp
->status
= STATUS_READ_ERROR
;
931 SetEvent (cp
->char_consumed
);
933 /* We used to forcibly terminate the thread here, but it
934 is normally unnecessary, and in abnormal cases, the worst that
935 will happen is we have an extra idle thread hanging around
936 waiting for the zombie process. */
937 if (WaitForSingleObject (cp
->thrd
, 1000) != WAIT_OBJECT_0
)
939 DebPrint (("delete_child.WaitForSingleObject (thread) failed "
940 "with %lu for fd %ld\n", GetLastError (), cp
->fd
));
941 TerminateThread (cp
->thrd
, 0);
945 CloseHandle (cp
->thrd
);
950 CloseHandle (cp
->char_avail
);
951 cp
->char_avail
= NULL
;
953 if (cp
->char_consumed
)
955 CloseHandle (cp
->char_consumed
);
956 cp
->char_consumed
= NULL
;
959 /* update child_proc_count (highest numbered slot in use plus one) */
960 if (cp
== child_procs
+ child_proc_count
- 1)
962 for (i
= child_proc_count
-1; i
>= 0; i
--)
963 if (CHILD_ACTIVE (&child_procs
[i
])
964 || child_procs
[i
].procinfo
.hProcess
!= NULL
)
966 child_proc_count
= i
+ 1;
971 child_proc_count
= 0;
974 /* Find a child by pid. */
975 static child_process
*
976 find_child_pid (DWORD pid
)
980 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
981 if ((CHILD_ACTIVE (cp
) || cp
->procinfo
.hProcess
!= NULL
)
988 /* Thread proc for child process and socket reader threads. Each thread
989 is normally blocked until woken by select() to check for input by
990 reading one char. When the read completes, char_avail is signaled
991 to wake up the select emulator and the thread blocks itself again. */
993 reader_thread (void *arg
)
998 cp
= (child_process
*)arg
;
1000 /* We have to wait for the go-ahead before we can start */
1002 || WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
1010 if (cp
->fd
>= 0 && fd_info
[cp
->fd
].flags
& FILE_LISTEN
)
1011 rc
= _sys_wait_accept (cp
->fd
);
1013 rc
= _sys_read_ahead (cp
->fd
);
1015 /* Don't bother waiting for the event if we already have been
1016 told to exit by delete_child. */
1017 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_avail
)
1020 /* The name char_avail is a misnomer - it really just means the
1021 read-ahead has completed, whether successfully or not. */
1022 if (!SetEvent (cp
->char_avail
))
1024 DebPrint (("reader_thread.SetEvent(0x%x) failed with %lu for fd %ld (PID %d)\n",
1025 (DWORD_PTR
)cp
->char_avail
, GetLastError (),
1030 if (rc
== STATUS_READ_ERROR
)
1033 /* If the read died, the child has died so let the thread die */
1034 if (rc
== STATUS_READ_FAILED
)
1037 /* Don't bother waiting for the acknowledge if we already have
1038 been told to exit by delete_child. */
1039 if (cp
->status
== STATUS_READ_ERROR
|| !cp
->char_consumed
)
1042 /* Wait until our input is acknowledged before reading again */
1043 if (WaitForSingleObject (cp
->char_consumed
, INFINITE
) != WAIT_OBJECT_0
)
1045 DebPrint (("reader_thread.WaitForSingleObject failed with "
1046 "%lu for fd %ld\n", GetLastError (), cp
->fd
));
1049 /* delete_child sets status to STATUS_READ_ERROR when it wants
1051 if (cp
->status
== STATUS_READ_ERROR
)
1057 /* To avoid Emacs changing directory, we just record here the directory
1058 the new process should start in. This is set just before calling
1059 sys_spawnve, and is not generally valid at any other time. */
1060 static char * process_dir
;
1063 create_child (char *exe
, char *cmdline
, char *env
, int is_gui_app
,
1064 int * pPid
, child_process
*cp
)
1067 SECURITY_ATTRIBUTES sec_attrs
;
1069 SECURITY_DESCRIPTOR sec_desc
;
1072 char dir
[ MAXPATHLEN
];
1074 if (cp
== NULL
) emacs_abort ();
1076 memset (&start
, 0, sizeof (start
));
1077 start
.cb
= sizeof (start
);
1080 if (NILP (Vw32_start_process_show_window
) && !is_gui_app
)
1081 start
.dwFlags
= STARTF_USESTDHANDLES
| STARTF_USESHOWWINDOW
;
1083 start
.dwFlags
= STARTF_USESTDHANDLES
;
1084 start
.wShowWindow
= SW_HIDE
;
1086 start
.hStdInput
= GetStdHandle (STD_INPUT_HANDLE
);
1087 start
.hStdOutput
= GetStdHandle (STD_OUTPUT_HANDLE
);
1088 start
.hStdError
= GetStdHandle (STD_ERROR_HANDLE
);
1089 #endif /* HAVE_NTGUI */
1092 /* Explicitly specify no security */
1093 if (!InitializeSecurityDescriptor (&sec_desc
, SECURITY_DESCRIPTOR_REVISION
))
1095 if (!SetSecurityDescriptorDacl (&sec_desc
, TRUE
, NULL
, FALSE
))
1098 sec_attrs
.nLength
= sizeof (sec_attrs
);
1099 sec_attrs
.lpSecurityDescriptor
= NULL
/* &sec_desc */;
1100 sec_attrs
.bInheritHandle
= FALSE
;
1102 strcpy (dir
, process_dir
);
1103 unixtodos_filename (dir
);
1105 flags
= (!NILP (Vw32_start_process_share_console
)
1106 ? CREATE_NEW_PROCESS_GROUP
1107 : CREATE_NEW_CONSOLE
);
1108 if (NILP (Vw32_start_process_inherit_error_mode
))
1109 flags
|= CREATE_DEFAULT_ERROR_MODE
;
1110 if (!CreateProcess (exe
, cmdline
, &sec_attrs
, NULL
, TRUE
,
1111 flags
, env
, dir
, &start
, &cp
->procinfo
))
1114 cp
->pid
= (int) cp
->procinfo
.dwProcessId
;
1116 /* Hack for Windows 95, which assigns large (ie negative) pids */
1125 DebPrint (("create_child.CreateProcess failed: %ld\n", GetLastError ()););
1129 /* create_child doesn't know what emacs' file handle will be for waiting
1130 on output from the child, so we need to make this additional call
1131 to register the handle with the process
1132 This way the select emulator knows how to match file handles with
1133 entries in child_procs. */
1135 register_child (pid_t pid
, int fd
)
1139 cp
= find_child_pid ((DWORD
)pid
);
1142 DebPrint (("register_child unable to find pid %lu\n", pid
));
1147 DebPrint (("register_child registered fd %d with pid %lu\n", fd
, pid
));
1152 /* thread is initially blocked until select is called; set status so
1153 that select will release thread */
1154 cp
->status
= STATUS_READ_ACKNOWLEDGED
;
1156 /* attach child_process to fd_info */
1157 if (fd_info
[fd
].cp
!= NULL
)
1159 DebPrint (("register_child: fd_info[%d] apparently in use!\n", fd
));
1163 fd_info
[fd
].cp
= cp
;
1166 /* Record INFILE as an input file for process PID. */
1168 record_infile (pid_t pid
, char *infile
)
1172 /* INFILE should never be NULL, since xstrdup would have signaled
1173 memory full condition in that case, see callproc.c where this
1174 function is called. */
1177 cp
= find_child_pid ((DWORD
)pid
);
1180 DebPrint (("record_infile is unable to find pid %lu\n", pid
));
1184 cp
->input_file
= infile
;
1187 /* Mark the input file INFILE of the corresponding subprocess as
1188 temporary, to be deleted when the subprocess exits. */
1190 record_pending_deletion (char *infile
)
1196 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1197 if (CHILD_ACTIVE (cp
)
1198 && cp
->input_file
&& xstrcasecmp (cp
->input_file
, infile
) == 0)
1200 cp
->pending_deletion
= 1;
1205 /* Called from waitpid when a process exits. */
1207 reap_subprocess (child_process
*cp
)
1209 if (cp
->procinfo
.hProcess
)
1211 /* Reap the process */
1213 /* Process should have already died before we are called. */
1214 if (WaitForSingleObject (cp
->procinfo
.hProcess
, 0) != WAIT_OBJECT_0
)
1215 DebPrint (("reap_subprocess: child for fd %d has not died yet!", cp
->fd
));
1217 CloseHandle (cp
->procinfo
.hProcess
);
1218 cp
->procinfo
.hProcess
= NULL
;
1219 CloseHandle (cp
->procinfo
.hThread
);
1220 cp
->procinfo
.hThread
= NULL
;
1223 /* If cp->fd was not closed yet, we might be still reading the
1224 process output, so don't free its resources just yet. The call
1225 to delete_child on behalf of this subprocess will be made by
1226 sys_read when the subprocess output is fully read. */
1231 /* Wait for a child process specified by PID, or for any of our
1232 existing child processes (if PID is nonpositive) to die. When it
1233 does, close its handle. Return the pid of the process that died
1234 and fill in STATUS if non-NULL. */
1237 waitpid (pid_t pid
, int *status
, int options
)
1239 DWORD active
, retval
;
1241 child_process
*cp
, *cps
[MAX_CHILDREN
];
1242 HANDLE wait_hnd
[MAX_CHILDREN
];
1244 int dont_wait
= (options
& WNOHANG
) != 0;
1247 /* According to Posix:
1249 PID = -1 means status is requested for any child process.
1251 PID > 0 means status is requested for a single child process
1254 PID = 0 means status is requested for any child process whose
1255 process group ID is equal to that of the calling process. But
1256 since Windows has only a limited support for process groups (only
1257 for console processes and only for the purposes of passing
1258 Ctrl-BREAK signal to them), and since we have no documented way
1259 of determining whether a given process belongs to our group, we
1262 PID < -1 means status is requested for any child process whose
1263 process group ID is equal to the absolute value of PID. Again,
1264 since we don't support process groups, we treat that as -1. */
1269 /* We are requested to wait for a specific child. */
1270 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1272 /* Some child_procs might be sockets; ignore them. Also
1273 ignore subprocesses whose output is not yet completely
1275 if (CHILD_ACTIVE (cp
)
1276 && cp
->procinfo
.hProcess
1285 if (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
1287 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1293 /* PID specifies our subprocess, but its status is not
1300 /* No such child process, or nothing to wait for, so fail. */
1307 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
1309 if (CHILD_ACTIVE (cp
)
1310 && cp
->procinfo
.hProcess
1311 && (cp
->fd
< 0 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0))
1313 wait_hnd
[nh
] = cp
->procinfo
.hProcess
;
1320 /* Nothing to wait on, so fail. */
1329 timeout_ms
= 1000; /* check for quit about once a second. */
1334 active
= WaitForMultipleObjects (nh
, wait_hnd
, FALSE
, timeout_ms
);
1335 } while (active
== WAIT_TIMEOUT
&& !dont_wait
);
1337 if (active
== WAIT_FAILED
)
1342 else if (active
== WAIT_TIMEOUT
&& dont_wait
)
1344 /* PID specifies our subprocess, but it didn't exit yet, so its
1345 status is not yet available. */
1347 DebPrint (("Wait: PID %d not reap yet\n", cp
->pid
));
1351 else if (active
>= WAIT_OBJECT_0
1352 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
1354 active
-= WAIT_OBJECT_0
;
1356 else if (active
>= WAIT_ABANDONED_0
1357 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
1359 active
-= WAIT_ABANDONED_0
;
1364 if (!GetExitCodeProcess (wait_hnd
[active
], &retval
))
1366 DebPrint (("Wait.GetExitCodeProcess failed with %lu\n",
1370 if (retval
== STILL_ACTIVE
)
1372 /* Should never happen. */
1373 DebPrint (("Wait.WaitForMultipleObjects returned an active process\n"));
1374 if (pid
> 0 && dont_wait
)
1380 /* Massage the exit code from the process to match the format expected
1381 by the WIFSTOPPED et al macros in syswait.h. Only WIFSIGNALED and
1382 WIFEXITED are supported; WIFSTOPPED doesn't make sense under NT. */
1384 if (retval
== STATUS_CONTROL_C_EXIT
)
1389 if (pid
> 0 && active
!= 0)
1394 DebPrint (("Wait signaled with process pid %d\n", cp
->pid
));
1399 reap_subprocess (cp
);
1404 /* Old versions of w32api headers don't have separate 32-bit and
1405 64-bit defines, but the one they have matches the 32-bit variety. */
1406 #ifndef IMAGE_NT_OPTIONAL_HDR32_MAGIC
1407 # define IMAGE_NT_OPTIONAL_HDR32_MAGIC IMAGE_NT_OPTIONAL_HDR_MAGIC
1408 # define IMAGE_OPTIONAL_HEADER32 IMAGE_OPTIONAL_HEADER
1412 w32_executable_type (char * filename
,
1414 int * is_cygnus_app
,
1417 file_data executable
;
1420 /* Default values in case we can't tell for sure. */
1421 *is_dos_app
= FALSE
;
1422 *is_cygnus_app
= FALSE
;
1423 *is_gui_app
= FALSE
;
1425 if (!open_input_file (&executable
, filename
))
1428 p
= strrchr (filename
, '.');
1430 /* We can only identify DOS .com programs from the extension. */
1431 if (p
&& xstrcasecmp (p
, ".com") == 0)
1433 else if (p
&& (xstrcasecmp (p
, ".bat") == 0
1434 || xstrcasecmp (p
, ".cmd") == 0))
1436 /* A DOS shell script - it appears that CreateProcess is happy to
1437 accept this (somewhat surprisingly); presumably it looks at
1438 COMSPEC to determine what executable to actually invoke.
1439 Therefore, we have to do the same here as well. */
1440 /* Actually, I think it uses the program association for that
1441 extension, which is defined in the registry. */
1442 p
= egetenv ("COMSPEC");
1444 w32_executable_type (p
, is_dos_app
, is_cygnus_app
, is_gui_app
);
1448 /* Look for DOS .exe signature - if found, we must also check that
1449 it isn't really a 16- or 32-bit Windows exe, since both formats
1450 start with a DOS program stub. Note that 16-bit Windows
1451 executables use the OS/2 1.x format. */
1453 IMAGE_DOS_HEADER
* dos_header
;
1454 IMAGE_NT_HEADERS
* nt_header
;
1456 dos_header
= (PIMAGE_DOS_HEADER
) executable
.file_base
;
1457 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
1460 nt_header
= (PIMAGE_NT_HEADERS
) ((unsigned char *) dos_header
+ dos_header
->e_lfanew
);
1462 if ((char *) nt_header
> (char *) dos_header
+ executable
.size
)
1464 /* Some dos headers (pkunzip) have bogus e_lfanew fields. */
1467 else if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
1468 && LOWORD (nt_header
->Signature
) != IMAGE_OS2_SIGNATURE
)
1472 else if (nt_header
->Signature
== IMAGE_NT_SIGNATURE
)
1474 IMAGE_DATA_DIRECTORY
*data_dir
= NULL
;
1475 if (nt_header
->OptionalHeader
.Magic
== IMAGE_NT_OPTIONAL_HDR32_MAGIC
)
1477 /* Ensure we are using the 32 bit structure. */
1478 IMAGE_OPTIONAL_HEADER32
*opt
1479 = (IMAGE_OPTIONAL_HEADER32
*) &(nt_header
->OptionalHeader
);
1480 data_dir
= opt
->DataDirectory
;
1481 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1483 /* MingW 3.12 has the required 64 bit structs, but in case older
1484 versions don't, only check 64 bit exes if we know how. */
1485 #ifdef IMAGE_NT_OPTIONAL_HDR64_MAGIC
1486 else if (nt_header
->OptionalHeader
.Magic
1487 == IMAGE_NT_OPTIONAL_HDR64_MAGIC
)
1489 IMAGE_OPTIONAL_HEADER64
*opt
1490 = (IMAGE_OPTIONAL_HEADER64
*) &(nt_header
->OptionalHeader
);
1491 data_dir
= opt
->DataDirectory
;
1492 *is_gui_app
= (opt
->Subsystem
== IMAGE_SUBSYSTEM_WINDOWS_GUI
);
1497 /* Look for cygwin.dll in DLL import list. */
1498 IMAGE_DATA_DIRECTORY import_dir
=
1499 data_dir
[IMAGE_DIRECTORY_ENTRY_IMPORT
];
1500 IMAGE_IMPORT_DESCRIPTOR
* imports
;
1501 IMAGE_SECTION_HEADER
* section
;
1503 section
= rva_to_section (import_dir
.VirtualAddress
, nt_header
);
1504 imports
= RVA_TO_PTR (import_dir
.VirtualAddress
, section
,
1507 for ( ; imports
->Name
; imports
++)
1509 char * dllname
= RVA_TO_PTR (imports
->Name
, section
,
1512 /* The exact name of the cygwin dll has changed with
1513 various releases, but hopefully this will be reasonably
1515 if (strncmp (dllname
, "cygwin", 6) == 0)
1517 *is_cygnus_app
= TRUE
;
1526 close_file_data (&executable
);
1530 compare_env (const void *strp1
, const void *strp2
)
1532 const char *str1
= *(const char **)strp1
, *str2
= *(const char **)strp2
;
1534 while (*str1
&& *str2
&& *str1
!= '=' && *str2
!= '=')
1536 /* Sort order in command.com/cmd.exe is based on uppercasing
1537 names, so do the same here. */
1538 if (toupper (*str1
) > toupper (*str2
))
1540 else if (toupper (*str1
) < toupper (*str2
))
1545 if (*str1
== '=' && *str2
== '=')
1547 else if (*str1
== '=')
1554 merge_and_sort_env (char **envp1
, char **envp2
, char **new_envp
)
1556 char **optr
, **nptr
;
1568 num
+= optr
- envp2
;
1570 qsort (new_envp
, num
, sizeof (char *), compare_env
);
1575 /* When a new child process is created we need to register it in our list,
1576 so intercept spawn requests. */
1578 sys_spawnve (int mode
, char *cmdname
, char **argv
, char **envp
)
1580 Lisp_Object program
, full
;
1581 char *cmdline
, *env
, *parg
, **targ
;
1585 int is_dos_app
, is_cygnus_app
, is_gui_app
;
1587 /* We pass our process ID to our children by setting up an environment
1588 variable in their environment. */
1589 char ppid_env_var_buffer
[64];
1590 char *extra_env
[] = {ppid_env_var_buffer
, NULL
};
1591 /* These are the characters that cause an argument to need quoting.
1592 Arguments with whitespace characters need quoting to prevent the
1593 argument being split into two or more. Arguments with wildcards
1594 are also quoted, for consistency with posix platforms, where wildcards
1595 are not expanded if we run the program directly without a shell.
1596 Some extra whitespace characters need quoting in Cygwin programs,
1597 so this list is conditionally modified below. */
1598 char *sepchars
= " \t*?";
1599 /* This is for native w32 apps; modified below for Cygwin apps. */
1600 char escape_char
= '\\';
1602 /* We don't care about the other modes */
1603 if (mode
!= _P_NOWAIT
)
1609 /* Handle executable names without an executable suffix. */
1610 program
= build_string (cmdname
);
1611 if (NILP (Ffile_executable_p (program
)))
1613 struct gcpro gcpro1
;
1617 openp (Vexec_path
, program
, Vexec_suffixes
, &full
, make_number (X_OK
));
1627 /* make sure argv[0] and cmdname are both in DOS format */
1628 cmdname
= SDATA (program
);
1629 unixtodos_filename (cmdname
);
1632 /* Determine whether program is a 16-bit DOS executable, or a 32-bit Windows
1633 executable that is implicitly linked to the Cygnus dll (implying it
1634 was compiled with the Cygnus GNU toolchain and hence relies on
1635 cygwin.dll to parse the command line - we use this to decide how to
1636 escape quote chars in command line args that must be quoted).
1638 Also determine whether it is a GUI app, so that we don't hide its
1639 initial window unless specifically requested. */
1640 w32_executable_type (cmdname
, &is_dos_app
, &is_cygnus_app
, &is_gui_app
);
1642 /* On Windows 95, if cmdname is a DOS app, we invoke a helper
1643 application to start it by specifying the helper app as cmdname,
1644 while leaving the real app name as argv[0]. */
1647 cmdname
= alloca (MAXPATHLEN
);
1648 if (egetenv ("CMDPROXY"))
1649 strcpy (cmdname
, egetenv ("CMDPROXY"));
1652 strcpy (cmdname
, SDATA (Vinvocation_directory
));
1653 strcat (cmdname
, "cmdproxy.exe");
1655 unixtodos_filename (cmdname
);
1658 /* we have to do some conjuring here to put argv and envp into the
1659 form CreateProcess wants... argv needs to be a space separated/null
1660 terminated list of parameters, and envp is a null
1661 separated/double-null terminated list of parameters.
1663 Additionally, zero-length args and args containing whitespace or
1664 quote chars need to be wrapped in double quotes - for this to work,
1665 embedded quotes need to be escaped as well. The aim is to ensure
1666 the child process reconstructs the argv array we start with
1667 exactly, so we treat quotes at the beginning and end of arguments
1670 The w32 GNU-based library from Cygnus doubles quotes to escape
1671 them, while MSVC uses backslash for escaping. (Actually the MSVC
1672 startup code does attempt to recognize doubled quotes and accept
1673 them, but gets it wrong and ends up requiring three quotes to get a
1674 single embedded quote!) So by default we decide whether to use
1675 quote or backslash as the escape character based on whether the
1676 binary is apparently a Cygnus compiled app.
1678 Note that using backslash to escape embedded quotes requires
1679 additional special handling if an embedded quote is already
1680 preceded by backslash, or if an arg requiring quoting ends with
1681 backslash. In such cases, the run of escape characters needs to be
1682 doubled. For consistency, we apply this special handling as long
1683 as the escape character is not quote.
1685 Since we have no idea how large argv and envp are likely to be we
1686 figure out list lengths on the fly and allocate them. */
1688 if (!NILP (Vw32_quote_process_args
))
1691 /* Override escape char by binding w32-quote-process-args to
1692 desired character, or use t for auto-selection. */
1693 if (INTEGERP (Vw32_quote_process_args
))
1694 escape_char
= XINT (Vw32_quote_process_args
);
1696 escape_char
= is_cygnus_app
? '"' : '\\';
1699 /* Cygwin apps needs quoting a bit more often. */
1700 if (escape_char
== '"')
1701 sepchars
= "\r\n\t\f '";
1709 int need_quotes
= 0;
1710 int escape_char_run
= 0;
1716 if (escape_char
== '"' && *p
== '\\')
1717 /* If it's a Cygwin app, \ needs to be escaped. */
1721 /* allow for embedded quotes to be escaped */
1724 /* handle the case where the embedded quote is already escaped */
1725 if (escape_char_run
> 0)
1727 /* To preserve the arg exactly, we need to double the
1728 preceding escape characters (plus adding one to
1729 escape the quote character itself). */
1730 arglen
+= escape_char_run
;
1733 else if (strchr (sepchars
, *p
) != NULL
)
1738 if (*p
== escape_char
&& escape_char
!= '"')
1741 escape_char_run
= 0;
1746 /* handle the case where the arg ends with an escape char - we
1747 must not let the enclosing quote be escaped. */
1748 if (escape_char_run
> 0)
1749 arglen
+= escape_char_run
;
1751 arglen
+= strlen (*targ
++) + 1;
1753 cmdline
= alloca (arglen
);
1759 int need_quotes
= 0;
1767 if ((strchr (sepchars
, *p
) != NULL
) || *p
== '"')
1772 int escape_char_run
= 0;
1778 last
= p
+ strlen (p
) - 1;
1781 /* This version does not escape quotes if they occur at the
1782 beginning or end of the arg - this could lead to incorrect
1783 behavior when the arg itself represents a command line
1784 containing quoted args. I believe this was originally done
1785 as a hack to make some things work, before
1786 `w32-quote-process-args' was added. */
1789 if (*p
== '"' && p
> first
&& p
< last
)
1790 *parg
++ = escape_char
; /* escape embedded quotes */
1798 /* double preceding escape chars if any */
1799 while (escape_char_run
> 0)
1801 *parg
++ = escape_char
;
1804 /* escape all quote chars, even at beginning or end */
1805 *parg
++ = escape_char
;
1807 else if (escape_char
== '"' && *p
== '\\')
1811 if (*p
== escape_char
&& escape_char
!= '"')
1814 escape_char_run
= 0;
1816 /* double escape chars before enclosing quote */
1817 while (escape_char_run
> 0)
1819 *parg
++ = escape_char
;
1827 strcpy (parg
, *targ
);
1828 parg
+= strlen (*targ
);
1838 numenv
= 1; /* for end null */
1841 arglen
+= strlen (*targ
++) + 1;
1844 /* extra env vars... */
1845 sprintf (ppid_env_var_buffer
, "EM_PARENT_PROCESS_ID=%lu",
1846 GetCurrentProcessId ());
1847 arglen
+= strlen (ppid_env_var_buffer
) + 1;
1850 /* merge env passed in and extra env into one, and sort it. */
1851 targ
= (char **) alloca (numenv
* sizeof (char *));
1852 merge_and_sort_env (envp
, extra_env
, targ
);
1854 /* concatenate env entries. */
1855 env
= alloca (arglen
);
1859 strcpy (parg
, *targ
);
1860 parg
+= strlen (*targ
++);
1873 /* Now create the process. */
1874 if (!create_child (cmdname
, cmdline
, env
, is_gui_app
, &pid
, cp
))
1884 /* Emulate the select call
1885 Wait for available input on any of the given rfds, or timeout if
1886 a timeout is given and no input is detected
1887 wfds and efds are not supported and must be NULL.
1889 For simplicity, we detect the death of child processes here and
1890 synchronously call the SIGCHLD handler. Since it is possible for
1891 children to be created without a corresponding pipe handle from which
1892 to read output, we wait separately on the process handles as well as
1893 the char_avail events for each process pipe. We only call
1894 wait/reap_process when the process actually terminates.
1896 To reduce the number of places in which Emacs can be hung such that
1897 C-g is not able to interrupt it, we always wait on interrupt_handle
1898 (which is signaled by the input thread when C-g is detected). If we
1899 detect that we were woken up by C-g, we return -1 with errno set to
1900 EINTR as on Unix. */
1902 /* From w32console.c */
1903 extern HANDLE keyboard_handle
;
1905 /* From w32xfns.c */
1906 extern HANDLE interrupt_handle
;
1908 /* From process.c */
1909 extern int proc_buffered_char
[];
1912 sys_select (int nfds
, SELECT_TYPE
*rfds
, SELECT_TYPE
*wfds
, SELECT_TYPE
*efds
,
1913 EMACS_TIME
*timeout
, void *ignored
)
1916 DWORD timeout_ms
, start_time
;
1919 child_process
*cp
, *cps
[MAX_CHILDREN
];
1920 HANDLE wait_hnd
[MAXDESC
+ MAX_CHILDREN
];
1921 int fdindex
[MAXDESC
]; /* mapping from wait handles back to descriptors */
1924 timeout
? (timeout
->tv_sec
* 1000 + timeout
->tv_nsec
/ 1000000) : INFINITE
;
1926 /* If the descriptor sets are NULL but timeout isn't, then just Sleep. */
1927 if (rfds
== NULL
&& wfds
== NULL
&& efds
== NULL
&& timeout
!= NULL
)
1933 /* Otherwise, we only handle rfds, so fail otherwise. */
1934 if (rfds
== NULL
|| wfds
!= NULL
|| efds
!= NULL
)
1944 /* Always wait on interrupt_handle, to detect C-g (quit). */
1945 wait_hnd
[0] = interrupt_handle
;
1948 /* Build a list of pipe handles to wait on. */
1950 for (i
= 0; i
< nfds
; i
++)
1951 if (FD_ISSET (i
, &orfds
))
1955 if (keyboard_handle
)
1957 /* Handle stdin specially */
1958 wait_hnd
[nh
] = keyboard_handle
;
1963 /* Check for any emacs-generated input in the queue since
1964 it won't be detected in the wait */
1965 if (detect_input_pending ())
1973 /* Child process and socket/comm port input. */
1977 int current_status
= cp
->status
;
1979 if (current_status
== STATUS_READ_ACKNOWLEDGED
)
1981 /* Tell reader thread which file handle to use. */
1983 /* Wake up the reader thread for this process */
1984 cp
->status
= STATUS_READ_READY
;
1985 if (!SetEvent (cp
->char_consumed
))
1986 DebPrint (("sys_select.SetEvent failed with "
1987 "%lu for fd %ld\n", GetLastError (), i
));
1990 #ifdef CHECK_INTERLOCK
1991 /* slightly crude cross-checking of interlock between threads */
1993 current_status
= cp
->status
;
1994 if (WaitForSingleObject (cp
->char_avail
, 0) == WAIT_OBJECT_0
)
1996 /* char_avail has been signaled, so status (which may
1997 have changed) should indicate read has completed
1998 but has not been acknowledged. */
1999 current_status
= cp
->status
;
2000 if (current_status
!= STATUS_READ_SUCCEEDED
2001 && current_status
!= STATUS_READ_FAILED
)
2002 DebPrint (("char_avail set, but read not completed: status %d\n",
2007 /* char_avail has not been signaled, so status should
2008 indicate that read is in progress; small possibility
2009 that read has completed but event wasn't yet signaled
2010 when we tested it (because a context switch occurred
2011 or if running on separate CPUs). */
2012 if (current_status
!= STATUS_READ_READY
2013 && current_status
!= STATUS_READ_IN_PROGRESS
2014 && current_status
!= STATUS_READ_SUCCEEDED
2015 && current_status
!= STATUS_READ_FAILED
)
2016 DebPrint (("char_avail reset, but read status is bad: %d\n",
2020 wait_hnd
[nh
] = cp
->char_avail
;
2022 if (!wait_hnd
[nh
]) emacs_abort ();
2025 DebPrint (("select waiting on child %d fd %d\n",
2026 cp
-child_procs
, i
));
2031 /* Unable to find something to wait on for this fd, skip */
2033 /* Note that this is not a fatal error, and can in fact
2034 happen in unusual circumstances. Specifically, if
2035 sys_spawnve fails, eg. because the program doesn't
2036 exist, and debug-on-error is t so Fsignal invokes a
2037 nested input loop, then the process output pipe is
2038 still included in input_wait_mask with no child_proc
2039 associated with it. (It is removed when the debugger
2040 exits the nested input loop and the error is thrown.) */
2042 DebPrint (("sys_select: fd %ld is invalid! ignoring\n", i
));
2048 /* Add handles of child processes. */
2050 for (cp
= child_procs
+ (child_proc_count
-1); cp
>= child_procs
; cp
--)
2051 /* Some child_procs might be sockets; ignore them. Also some
2052 children may have died already, but we haven't finished reading
2053 the process output; ignore them too. */
2054 if ((CHILD_ACTIVE (cp
) && cp
->procinfo
.hProcess
)
2056 || (fd_info
[cp
->fd
].flags
& FILE_SEND_SIGCHLD
) == 0
2057 || (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) != 0)
2060 wait_hnd
[nh
+ nc
] = cp
->procinfo
.hProcess
;
2065 /* Nothing to look for, so we didn't find anything */
2073 start_time
= GetTickCount ();
2075 /* Wait for input or child death to be signaled. If user input is
2076 allowed, then also accept window messages. */
2077 if (FD_ISSET (0, &orfds
))
2078 active
= MsgWaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
,
2081 active
= WaitForMultipleObjects (nh
+ nc
, wait_hnd
, FALSE
, timeout_ms
);
2083 if (active
== WAIT_FAILED
)
2085 DebPrint (("select.WaitForMultipleObjects (%d, %lu) failed with %lu\n",
2086 nh
+ nc
, timeout_ms
, GetLastError ()));
2087 /* don't return EBADF - this causes wait_reading_process_output to
2088 abort; WAIT_FAILED is returned when single-stepping under
2089 Windows 95 after switching thread focus in debugger, and
2090 possibly at other times. */
2094 else if (active
== WAIT_TIMEOUT
)
2098 else if (active
>= WAIT_OBJECT_0
2099 && active
< WAIT_OBJECT_0
+MAXIMUM_WAIT_OBJECTS
)
2101 active
-= WAIT_OBJECT_0
;
2103 else if (active
>= WAIT_ABANDONED_0
2104 && active
< WAIT_ABANDONED_0
+MAXIMUM_WAIT_OBJECTS
)
2106 active
-= WAIT_ABANDONED_0
;
2111 /* Loop over all handles after active (now officially documented as
2112 being the first signaled handle in the array). We do this to
2113 ensure fairness, so that all channels with data available will be
2114 processed - otherwise higher numbered channels could be starved. */
2117 if (active
== nh
+ nc
)
2119 /* There are messages in the lisp thread's queue; we must
2120 drain the queue now to ensure they are processed promptly,
2121 because if we don't do so, we will not be woken again until
2122 further messages arrive.
2124 NB. If ever we allow window message procedures to callback
2125 into lisp, we will need to ensure messages are dispatched
2126 at a safe time for lisp code to be run (*), and we may also
2127 want to provide some hooks in the dispatch loop to cater
2128 for modeless dialogs created by lisp (ie. to register
2129 window handles to pass to IsDialogMessage).
2131 (*) Note that MsgWaitForMultipleObjects above is an
2132 internal dispatch point for messages that are sent to
2133 windows created by this thread. */
2134 if (drain_message_queue ()
2135 /* If drain_message_queue returns non-zero, that means
2136 we received a WM_EMACS_FILENOTIFY message. If this
2137 is a TTY frame, we must signal the caller that keyboard
2138 input is available, so that w32_console_read_socket
2139 will be called to pick up the notifications. If we
2140 don't do that, file notifications will only work when
2141 the Emacs TTY frame has focus. */
2142 && FRAME_TERMCAP_P (SELECTED_FRAME ())
2143 /* they asked for stdin reads */
2144 && FD_ISSET (0, &orfds
)
2145 /* the stdin handle is valid */
2153 else if (active
>= nh
)
2155 cp
= cps
[active
- nh
];
2157 /* We cannot always signal SIGCHLD immediately; if we have not
2158 finished reading the process output, we must delay sending
2159 SIGCHLD until we do. */
2161 if (cp
->fd
>= 0 && (fd_info
[cp
->fd
].flags
& FILE_AT_EOF
) == 0)
2162 fd_info
[cp
->fd
].flags
|= FILE_SEND_SIGCHLD
;
2163 /* SIG_DFL for SIGCHLD is ignore */
2164 else if (sig_handlers
[SIGCHLD
] != SIG_DFL
&&
2165 sig_handlers
[SIGCHLD
] != SIG_IGN
)
2168 DebPrint (("select calling SIGCHLD handler for pid %d\n",
2171 sig_handlers
[SIGCHLD
] (SIGCHLD
);
2174 else if (fdindex
[active
] == -1)
2176 /* Quit (C-g) was detected. */
2180 else if (fdindex
[active
] == 0)
2182 /* Keyboard input available */
2188 /* must be a socket or pipe - read ahead should have
2189 completed, either succeeding or failing. */
2190 FD_SET (fdindex
[active
], rfds
);
2194 /* Even though wait_reading_process_output only reads from at most
2195 one channel, we must process all channels here so that we reap
2196 all children that have died. */
2197 while (++active
< nh
+ nc
)
2198 if (WaitForSingleObject (wait_hnd
[active
], 0) == WAIT_OBJECT_0
)
2200 } while (active
< nh
+ nc
);
2202 /* If no input has arrived and timeout hasn't expired, wait again. */
2205 DWORD elapsed
= GetTickCount () - start_time
;
2207 if (timeout_ms
> elapsed
) /* INFINITE is MAX_UINT */
2209 if (timeout_ms
!= INFINITE
)
2210 timeout_ms
-= elapsed
;
2211 goto count_children
;
2218 /* Substitute for certain kill () operations */
2220 static BOOL CALLBACK
2221 find_child_console (HWND hwnd
, LPARAM arg
)
2223 child_process
* cp
= (child_process
*) arg
;
2227 thread_id
= GetWindowThreadProcessId (hwnd
, &process_id
);
2228 if (process_id
== cp
->procinfo
.dwProcessId
)
2230 char window_class
[32];
2232 GetClassName (hwnd
, window_class
, sizeof (window_class
));
2233 if (strcmp (window_class
,
2234 (os_subtype
== OS_9X
)
2236 : "ConsoleWindowClass") == 0)
2246 /* Emulate 'kill', but only for other processes. */
2248 sys_kill (pid_t pid
, int sig
)
2252 int need_to_free
= 0;
2255 /* Each process is in its own process group. */
2259 /* Only handle signals that will result in the process dying */
2260 if (sig
!= SIGINT
&& sig
!= SIGKILL
&& sig
!= SIGQUIT
&& sig
!= SIGHUP
)
2266 cp
= find_child_pid (pid
);
2269 /* We were passed a PID of something other than our subprocess.
2270 If that is our own PID, we will send to ourself a message to
2271 close the selected frame, which does not necessarily
2272 terminates Emacs. But then we are not supposed to call
2273 sys_kill with our own PID. */
2274 proc_hand
= OpenProcess (PROCESS_TERMINATE
, 0, pid
);
2275 if (proc_hand
== NULL
)
2284 proc_hand
= cp
->procinfo
.hProcess
;
2285 pid
= cp
->procinfo
.dwProcessId
;
2287 /* Try to locate console window for process. */
2288 EnumWindows (find_child_console
, (LPARAM
) cp
);
2291 if (sig
== SIGINT
|| sig
== SIGQUIT
)
2293 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2295 BYTE control_scan_code
= (BYTE
) MapVirtualKey (VK_CONTROL
, 0);
2296 /* Fake Ctrl-C for SIGINT, and Ctrl-Break for SIGQUIT. */
2297 BYTE vk_break_code
= (sig
== SIGINT
) ? 'C' : VK_CANCEL
;
2298 BYTE break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2299 HWND foreground_window
;
2301 if (break_scan_code
== 0)
2303 /* Fake Ctrl-C for SIGQUIT if we can't manage Ctrl-Break. */
2304 vk_break_code
= 'C';
2305 break_scan_code
= (BYTE
) MapVirtualKey (vk_break_code
, 0);
2308 foreground_window
= GetForegroundWindow ();
2309 if (foreground_window
)
2311 /* NT 5.0, and apparently also Windows 98, will not allow
2312 a Window to be set to foreground directly without the
2313 user's involvement. The workaround is to attach
2314 ourselves to the thread that owns the foreground
2315 window, since that is the only thread that can set the
2316 foreground window. */
2317 DWORD foreground_thread
, child_thread
;
2319 GetWindowThreadProcessId (foreground_window
, NULL
);
2320 if (foreground_thread
== GetCurrentThreadId ()
2321 || !AttachThreadInput (GetCurrentThreadId (),
2322 foreground_thread
, TRUE
))
2323 foreground_thread
= 0;
2325 child_thread
= GetWindowThreadProcessId (cp
->hwnd
, NULL
);
2326 if (child_thread
== GetCurrentThreadId ()
2327 || !AttachThreadInput (GetCurrentThreadId (),
2328 child_thread
, TRUE
))
2331 /* Set the foreground window to the child. */
2332 if (SetForegroundWindow (cp
->hwnd
))
2334 /* Generate keystrokes as if user had typed Ctrl-Break or
2336 keybd_event (VK_CONTROL
, control_scan_code
, 0, 0);
2337 keybd_event (vk_break_code
, break_scan_code
,
2338 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
), 0);
2339 keybd_event (vk_break_code
, break_scan_code
,
2340 (vk_break_code
== 'C' ? 0 : KEYEVENTF_EXTENDEDKEY
)
2341 | KEYEVENTF_KEYUP
, 0);
2342 keybd_event (VK_CONTROL
, control_scan_code
,
2343 KEYEVENTF_KEYUP
, 0);
2345 /* Sleep for a bit to give time for Emacs frame to respond
2346 to focus change events (if Emacs was active app). */
2349 SetForegroundWindow (foreground_window
);
2351 /* Detach from the foreground and child threads now that
2352 the foreground switching is over. */
2353 if (foreground_thread
)
2354 AttachThreadInput (GetCurrentThreadId (),
2355 foreground_thread
, FALSE
);
2357 AttachThreadInput (GetCurrentThreadId (),
2358 child_thread
, FALSE
);
2361 /* Ctrl-Break is NT equivalent of SIGINT. */
2362 else if (!GenerateConsoleCtrlEvent (CTRL_BREAK_EVENT
, pid
))
2364 DebPrint (("sys_kill.GenerateConsoleCtrlEvent return %d "
2365 "for pid %lu\n", GetLastError (), pid
));
2372 if (NILP (Vw32_start_process_share_console
) && cp
&& cp
->hwnd
)
2375 if (os_subtype
== OS_9X
)
2378 Another possibility is to try terminating the VDM out-right by
2379 calling the Shell VxD (id 0x17) V86 interface, function #4
2380 "SHELL_Destroy_VM", ie.
2386 First need to determine the current VM handle, and then arrange for
2387 the shellapi call to be made from the system vm (by using
2388 Switch_VM_and_callback).
2390 Could try to invoke DestroyVM through CallVxD.
2394 /* On Windows 95, posting WM_QUIT causes the 16-bit subsystem
2395 to hang when cmdproxy is used in conjunction with
2396 command.com for an interactive shell. Posting
2397 WM_CLOSE pops up a dialog that, when Yes is selected,
2398 does the same thing. TerminateProcess is also less
2399 than ideal in that subprocesses tend to stick around
2400 until the machine is shutdown, but at least it
2401 doesn't freeze the 16-bit subsystem. */
2402 PostMessage (cp
->hwnd
, WM_QUIT
, 0xff, 0);
2404 if (!TerminateProcess (proc_hand
, 0xff))
2406 DebPrint (("sys_kill.TerminateProcess returned %d "
2407 "for pid %lu\n", GetLastError (), pid
));
2414 PostMessage (cp
->hwnd
, WM_CLOSE
, 0, 0);
2416 /* Kill the process. On W32 this doesn't kill child processes
2417 so it doesn't work very well for shells which is why it's not
2418 used in every case. */
2419 else if (!TerminateProcess (proc_hand
, 0xff))
2421 DebPrint (("sys_kill.TerminateProcess returned %d "
2422 "for pid %lu\n", GetLastError (), pid
));
2429 CloseHandle (proc_hand
);
2434 /* The following two routines are used to manipulate stdin, stdout, and
2435 stderr of our child processes.
2437 Assuming that in, out, and err are *not* inheritable, we make them
2438 stdin, stdout, and stderr of the child as follows:
2440 - Save the parent's current standard handles.
2441 - Set the std handles to inheritable duplicates of the ones being passed in.
2442 (Note that _get_osfhandle() is an io.h procedure that retrieves the
2443 NT file handle for a crt file descriptor.)
2444 - Spawn the child, which inherits in, out, and err as stdin,
2445 stdout, and stderr. (see Spawnve)
2446 - Close the std handles passed to the child.
2447 - Reset the parent's standard handles to the saved handles.
2448 (see reset_standard_handles)
2449 We assume that the caller closes in, out, and err after calling us. */
2452 prepare_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2455 HANDLE newstdin
, newstdout
, newstderr
;
2457 parent
= GetCurrentProcess ();
2459 handles
[0] = GetStdHandle (STD_INPUT_HANDLE
);
2460 handles
[1] = GetStdHandle (STD_OUTPUT_HANDLE
);
2461 handles
[2] = GetStdHandle (STD_ERROR_HANDLE
);
2463 /* make inheritable copies of the new handles */
2464 if (!DuplicateHandle (parent
,
2465 (HANDLE
) _get_osfhandle (in
),
2470 DUPLICATE_SAME_ACCESS
))
2471 report_file_error ("Duplicating input handle for child", Qnil
);
2473 if (!DuplicateHandle (parent
,
2474 (HANDLE
) _get_osfhandle (out
),
2479 DUPLICATE_SAME_ACCESS
))
2480 report_file_error ("Duplicating output handle for child", Qnil
);
2482 if (!DuplicateHandle (parent
,
2483 (HANDLE
) _get_osfhandle (err
),
2488 DUPLICATE_SAME_ACCESS
))
2489 report_file_error ("Duplicating error handle for child", Qnil
);
2491 /* and store them as our std handles */
2492 if (!SetStdHandle (STD_INPUT_HANDLE
, newstdin
))
2493 report_file_error ("Changing stdin handle", Qnil
);
2495 if (!SetStdHandle (STD_OUTPUT_HANDLE
, newstdout
))
2496 report_file_error ("Changing stdout handle", Qnil
);
2498 if (!SetStdHandle (STD_ERROR_HANDLE
, newstderr
))
2499 report_file_error ("Changing stderr handle", Qnil
);
2503 reset_standard_handles (int in
, int out
, int err
, HANDLE handles
[3])
2505 /* close the duplicated handles passed to the child */
2506 CloseHandle (GetStdHandle (STD_INPUT_HANDLE
));
2507 CloseHandle (GetStdHandle (STD_OUTPUT_HANDLE
));
2508 CloseHandle (GetStdHandle (STD_ERROR_HANDLE
));
2510 /* now restore parent's saved std handles */
2511 SetStdHandle (STD_INPUT_HANDLE
, handles
[0]);
2512 SetStdHandle (STD_OUTPUT_HANDLE
, handles
[1]);
2513 SetStdHandle (STD_ERROR_HANDLE
, handles
[2]);
2517 set_process_dir (char * dir
)
2522 /* To avoid problems with winsock implementations that work over dial-up
2523 connections causing or requiring a connection to exist while Emacs is
2524 running, Emacs no longer automatically loads winsock on startup if it
2525 is present. Instead, it will be loaded when open-network-stream is
2528 To allow full control over when winsock is loaded, we provide these
2529 two functions to dynamically load and unload winsock. This allows
2530 dial-up users to only be connected when they actually need to use
2534 extern HANDLE winsock_lib
;
2535 extern BOOL
term_winsock (void);
2536 extern BOOL
init_winsock (int load_now
);
2538 DEFUN ("w32-has-winsock", Fw32_has_winsock
, Sw32_has_winsock
, 0, 1, 0,
2539 doc
: /* Test for presence of the Windows socket library `winsock'.
2540 Returns non-nil if winsock support is present, nil otherwise.
2542 If the optional argument LOAD-NOW is non-nil, the winsock library is
2543 also loaded immediately if not already loaded. If winsock is loaded,
2544 the winsock local hostname is returned (since this may be different from
2545 the value of `system-name' and should supplant it), otherwise t is
2546 returned to indicate winsock support is present. */)
2547 (Lisp_Object load_now
)
2551 have_winsock
= init_winsock (!NILP (load_now
));
2554 if (winsock_lib
!= NULL
)
2556 /* Return new value for system-name. The best way to do this
2557 is to call init_system_name, saving and restoring the
2558 original value to avoid side-effects. */
2559 Lisp_Object orig_hostname
= Vsystem_name
;
2560 Lisp_Object hostname
;
2562 init_system_name ();
2563 hostname
= Vsystem_name
;
2564 Vsystem_name
= orig_hostname
;
2572 DEFUN ("w32-unload-winsock", Fw32_unload_winsock
, Sw32_unload_winsock
,
2574 doc
: /* Unload the Windows socket library `winsock' if loaded.
2575 This is provided to allow dial-up socket connections to be disconnected
2576 when no longer needed. Returns nil without unloading winsock if any
2577 socket connections still exist. */)
2580 return term_winsock () ? Qt
: Qnil
;
2584 /* Some miscellaneous functions that are Windows specific, but not GUI
2585 specific (ie. are applicable in terminal or batch mode as well). */
2587 DEFUN ("w32-short-file-name", Fw32_short_file_name
, Sw32_short_file_name
, 1, 1, 0,
2588 doc
: /* Return the short file name version (8.3) of the full path of FILENAME.
2589 If FILENAME does not exist, return nil.
2590 All path elements in FILENAME are converted to their short names. */)
2591 (Lisp_Object filename
)
2593 char shortname
[MAX_PATH
];
2595 CHECK_STRING (filename
);
2597 /* first expand it. */
2598 filename
= Fexpand_file_name (filename
, Qnil
);
2600 /* luckily, this returns the short version of each element in the path. */
2601 if (GetShortPathName (SDATA (ENCODE_FILE (filename
)), shortname
, MAX_PATH
) == 0)
2604 dostounix_filename (shortname
, 0);
2606 /* No need to DECODE_FILE, because 8.3 names are pure ASCII. */
2607 return build_string (shortname
);
2611 DEFUN ("w32-long-file-name", Fw32_long_file_name
, Sw32_long_file_name
,
2613 doc
: /* Return the long file name version of the full path of FILENAME.
2614 If FILENAME does not exist, return nil.
2615 All path elements in FILENAME are converted to their long names. */)
2616 (Lisp_Object filename
)
2618 char longname
[ MAX_PATH
];
2621 CHECK_STRING (filename
);
2623 if (SBYTES (filename
) == 2
2624 && *(SDATA (filename
) + 1) == ':')
2627 /* first expand it. */
2628 filename
= Fexpand_file_name (filename
, Qnil
);
2630 if (!w32_get_long_filename (SDATA (ENCODE_FILE (filename
)), longname
, MAX_PATH
))
2633 dostounix_filename (longname
, 0);
2635 /* If we were passed only a drive, make sure that a slash is not appended
2636 for consistency with directories. Allow for drive mapping via SUBST
2637 in case expand-file-name is ever changed to expand those. */
2638 if (drive_only
&& longname
[1] == ':' && longname
[2] == '/' && !longname
[3])
2641 return DECODE_FILE (build_string (longname
));
2644 DEFUN ("w32-set-process-priority", Fw32_set_process_priority
,
2645 Sw32_set_process_priority
, 2, 2, 0,
2646 doc
: /* Set the priority of PROCESS to PRIORITY.
2647 If PROCESS is nil, the priority of Emacs is changed, otherwise the
2648 priority of the process whose pid is PROCESS is changed.
2649 PRIORITY should be one of the symbols high, normal, or low;
2650 any other symbol will be interpreted as normal.
2652 If successful, the return value is t, otherwise nil. */)
2653 (Lisp_Object process
, Lisp_Object priority
)
2655 HANDLE proc_handle
= GetCurrentProcess ();
2656 DWORD priority_class
= NORMAL_PRIORITY_CLASS
;
2657 Lisp_Object result
= Qnil
;
2659 CHECK_SYMBOL (priority
);
2661 if (!NILP (process
))
2666 CHECK_NUMBER (process
);
2668 /* Allow pid to be an internally generated one, or one obtained
2669 externally. This is necessary because real pids on Windows 95 are
2672 pid
= XINT (process
);
2673 cp
= find_child_pid (pid
);
2675 pid
= cp
->procinfo
.dwProcessId
;
2677 proc_handle
= OpenProcess (PROCESS_SET_INFORMATION
, FALSE
, pid
);
2680 if (EQ (priority
, Qhigh
))
2681 priority_class
= HIGH_PRIORITY_CLASS
;
2682 else if (EQ (priority
, Qlow
))
2683 priority_class
= IDLE_PRIORITY_CLASS
;
2685 if (proc_handle
!= NULL
)
2687 if (SetPriorityClass (proc_handle
, priority_class
))
2689 if (!NILP (process
))
2690 CloseHandle (proc_handle
);
2696 #ifdef HAVE_LANGINFO_CODESET
2697 /* Emulation of nl_langinfo. Used in fns.c:Flocale_info. */
2699 nl_langinfo (nl_item item
)
2701 /* Conversion of Posix item numbers to their Windows equivalents. */
2702 static const LCTYPE w32item
[] = {
2703 LOCALE_IDEFAULTANSICODEPAGE
,
2704 LOCALE_SDAYNAME1
, LOCALE_SDAYNAME2
, LOCALE_SDAYNAME3
,
2705 LOCALE_SDAYNAME4
, LOCALE_SDAYNAME5
, LOCALE_SDAYNAME6
, LOCALE_SDAYNAME7
,
2706 LOCALE_SMONTHNAME1
, LOCALE_SMONTHNAME2
, LOCALE_SMONTHNAME3
,
2707 LOCALE_SMONTHNAME4
, LOCALE_SMONTHNAME5
, LOCALE_SMONTHNAME6
,
2708 LOCALE_SMONTHNAME7
, LOCALE_SMONTHNAME8
, LOCALE_SMONTHNAME9
,
2709 LOCALE_SMONTHNAME10
, LOCALE_SMONTHNAME11
, LOCALE_SMONTHNAME12
2712 static char *nl_langinfo_buf
= NULL
;
2713 static int nl_langinfo_len
= 0;
2715 if (nl_langinfo_len
<= 0)
2716 nl_langinfo_buf
= xmalloc (nl_langinfo_len
= 1);
2718 if (item
< 0 || item
>= _NL_NUM
)
2719 nl_langinfo_buf
[0] = 0;
2722 LCID cloc
= GetThreadLocale ();
2723 int need_len
= GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2727 nl_langinfo_buf
[0] = 0;
2730 if (item
== CODESET
)
2732 need_len
+= 2; /* for the "cp" prefix */
2733 if (need_len
< 8) /* for the case we call GetACP */
2736 if (nl_langinfo_len
<= need_len
)
2737 nl_langinfo_buf
= xrealloc (nl_langinfo_buf
,
2738 nl_langinfo_len
= need_len
);
2739 if (!GetLocaleInfo (cloc
, w32item
[item
] | LOCALE_USE_CP_ACP
,
2740 nl_langinfo_buf
, nl_langinfo_len
))
2741 nl_langinfo_buf
[0] = 0;
2742 else if (item
== CODESET
)
2744 if (strcmp (nl_langinfo_buf
, "0") == 0 /* CP_ACP */
2745 || strcmp (nl_langinfo_buf
, "1") == 0) /* CP_OEMCP */
2746 sprintf (nl_langinfo_buf
, "cp%u", GetACP ());
2749 memmove (nl_langinfo_buf
+ 2, nl_langinfo_buf
,
2750 strlen (nl_langinfo_buf
) + 1);
2751 nl_langinfo_buf
[0] = 'c';
2752 nl_langinfo_buf
[1] = 'p';
2757 return nl_langinfo_buf
;
2759 #endif /* HAVE_LANGINFO_CODESET */
2761 DEFUN ("w32-get-locale-info", Fw32_get_locale_info
,
2762 Sw32_get_locale_info
, 1, 2, 0,
2763 doc
: /* Return information about the Windows locale LCID.
2764 By default, return a three letter locale code which encodes the default
2765 language as the first two characters, and the country or regional variant
2766 as the third letter. For example, ENU refers to `English (United States)',
2767 while ENC means `English (Canadian)'.
2769 If the optional argument LONGFORM is t, the long form of the locale
2770 name is returned, e.g. `English (United States)' instead; if LONGFORM
2771 is a number, it is interpreted as an LCTYPE constant and the corresponding
2772 locale information is returned.
2774 If LCID (a 16-bit number) is not a valid locale, the result is nil. */)
2775 (Lisp_Object lcid
, Lisp_Object longform
)
2779 char abbrev_name
[32] = { 0 };
2780 char full_name
[256] = { 0 };
2782 CHECK_NUMBER (lcid
);
2784 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2787 if (NILP (longform
))
2789 got_abbrev
= GetLocaleInfo (XINT (lcid
),
2790 LOCALE_SABBREVLANGNAME
| LOCALE_USE_CP_ACP
,
2791 abbrev_name
, sizeof (abbrev_name
));
2793 return build_string (abbrev_name
);
2795 else if (EQ (longform
, Qt
))
2797 got_full
= GetLocaleInfo (XINT (lcid
),
2798 LOCALE_SLANGUAGE
| LOCALE_USE_CP_ACP
,
2799 full_name
, sizeof (full_name
));
2801 return DECODE_SYSTEM (build_string (full_name
));
2803 else if (NUMBERP (longform
))
2805 got_full
= GetLocaleInfo (XINT (lcid
),
2807 full_name
, sizeof (full_name
));
2808 /* GetLocaleInfo's return value includes the terminating null
2809 character, when the returned information is a string, whereas
2810 make_unibyte_string needs the string length without the
2811 terminating null. */
2813 return make_unibyte_string (full_name
, got_full
- 1);
2820 DEFUN ("w32-get-current-locale-id", Fw32_get_current_locale_id
,
2821 Sw32_get_current_locale_id
, 0, 0, 0,
2822 doc
: /* Return Windows locale id for current locale setting.
2823 This is a numerical value; use `w32-get-locale-info' to convert to a
2824 human-readable form. */)
2827 return make_number (GetThreadLocale ());
2831 int_from_hex (char * s
)
2834 static char hex
[] = "0123456789abcdefABCDEF";
2837 while (*s
&& (p
= strchr (hex
, *s
)) != NULL
)
2839 unsigned digit
= p
- hex
;
2842 val
= val
* 16 + digit
;
2848 /* We need to build a global list, since the EnumSystemLocale callback
2849 function isn't given a context pointer. */
2850 Lisp_Object Vw32_valid_locale_ids
;
2852 static BOOL CALLBACK
2853 enum_locale_fn (LPTSTR localeNum
)
2855 DWORD id
= int_from_hex (localeNum
);
2856 Vw32_valid_locale_ids
= Fcons (make_number (id
), Vw32_valid_locale_ids
);
2860 DEFUN ("w32-get-valid-locale-ids", Fw32_get_valid_locale_ids
,
2861 Sw32_get_valid_locale_ids
, 0, 0, 0,
2862 doc
: /* Return list of all valid Windows locale ids.
2863 Each id is a numerical value; use `w32-get-locale-info' to convert to a
2864 human-readable form. */)
2867 Vw32_valid_locale_ids
= Qnil
;
2869 EnumSystemLocales (enum_locale_fn
, LCID_SUPPORTED
);
2871 Vw32_valid_locale_ids
= Fnreverse (Vw32_valid_locale_ids
);
2872 return Vw32_valid_locale_ids
;
2876 DEFUN ("w32-get-default-locale-id", Fw32_get_default_locale_id
, Sw32_get_default_locale_id
, 0, 1, 0,
2877 doc
: /* Return Windows locale id for default locale setting.
2878 By default, the system default locale setting is returned; if the optional
2879 parameter USERP is non-nil, the user default locale setting is returned.
2880 This is a numerical value; use `w32-get-locale-info' to convert to a
2881 human-readable form. */)
2885 return make_number (GetSystemDefaultLCID ());
2886 return make_number (GetUserDefaultLCID ());
2890 DEFUN ("w32-set-current-locale", Fw32_set_current_locale
, Sw32_set_current_locale
, 1, 1, 0,
2891 doc
: /* Make Windows locale LCID be the current locale setting for Emacs.
2892 If successful, the new locale id is returned, otherwise nil. */)
2895 CHECK_NUMBER (lcid
);
2897 if (!IsValidLocale (XINT (lcid
), LCID_SUPPORTED
))
2900 if (!SetThreadLocale (XINT (lcid
)))
2903 /* Need to set input thread locale if present. */
2904 if (dwWindowsThreadId
)
2905 /* Reply is not needed. */
2906 PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETLOCALE
, XINT (lcid
), 0);
2908 return make_number (GetThreadLocale ());
2912 /* We need to build a global list, since the EnumCodePages callback
2913 function isn't given a context pointer. */
2914 Lisp_Object Vw32_valid_codepages
;
2916 static BOOL CALLBACK
2917 enum_codepage_fn (LPTSTR codepageNum
)
2919 DWORD id
= atoi (codepageNum
);
2920 Vw32_valid_codepages
= Fcons (make_number (id
), Vw32_valid_codepages
);
2924 DEFUN ("w32-get-valid-codepages", Fw32_get_valid_codepages
,
2925 Sw32_get_valid_codepages
, 0, 0, 0,
2926 doc
: /* Return list of all valid Windows codepages. */)
2929 Vw32_valid_codepages
= Qnil
;
2931 EnumSystemCodePages (enum_codepage_fn
, CP_SUPPORTED
);
2933 Vw32_valid_codepages
= Fnreverse (Vw32_valid_codepages
);
2934 return Vw32_valid_codepages
;
2938 DEFUN ("w32-get-console-codepage", Fw32_get_console_codepage
,
2939 Sw32_get_console_codepage
, 0, 0, 0,
2940 doc
: /* Return current Windows codepage for console input. */)
2943 return make_number (GetConsoleCP ());
2947 DEFUN ("w32-set-console-codepage", Fw32_set_console_codepage
,
2948 Sw32_set_console_codepage
, 1, 1, 0,
2949 doc
: /* Make Windows codepage CP be the codepage for Emacs tty keyboard input.
2950 This codepage setting affects keyboard input in tty mode.
2951 If successful, the new CP is returned, otherwise nil. */)
2956 if (!IsValidCodePage (XINT (cp
)))
2959 if (!SetConsoleCP (XINT (cp
)))
2962 return make_number (GetConsoleCP ());
2966 DEFUN ("w32-get-console-output-codepage", Fw32_get_console_output_codepage
,
2967 Sw32_get_console_output_codepage
, 0, 0, 0,
2968 doc
: /* Return current Windows codepage for console output. */)
2971 return make_number (GetConsoleOutputCP ());
2975 DEFUN ("w32-set-console-output-codepage", Fw32_set_console_output_codepage
,
2976 Sw32_set_console_output_codepage
, 1, 1, 0,
2977 doc
: /* Make Windows codepage CP be the codepage for Emacs console output.
2978 This codepage setting affects display in tty mode.
2979 If successful, the new CP is returned, otherwise nil. */)
2984 if (!IsValidCodePage (XINT (cp
)))
2987 if (!SetConsoleOutputCP (XINT (cp
)))
2990 return make_number (GetConsoleOutputCP ());
2994 DEFUN ("w32-get-codepage-charset", Fw32_get_codepage_charset
,
2995 Sw32_get_codepage_charset
, 1, 1, 0,
2996 doc
: /* Return charset ID corresponding to codepage CP.
2997 Returns nil if the codepage is not valid. */)
3004 if (!IsValidCodePage (XINT (cp
)))
3007 if (TranslateCharsetInfo ((DWORD
*) XINT (cp
), &info
, TCI_SRCCODEPAGE
))
3008 return make_number (info
.ciCharset
);
3014 DEFUN ("w32-get-valid-keyboard-layouts", Fw32_get_valid_keyboard_layouts
,
3015 Sw32_get_valid_keyboard_layouts
, 0, 0, 0,
3016 doc
: /* Return list of Windows keyboard languages and layouts.
3017 The return value is a list of pairs of language id and layout id. */)
3020 int num_layouts
= GetKeyboardLayoutList (0, NULL
);
3021 HKL
* layouts
= (HKL
*) alloca (num_layouts
* sizeof (HKL
));
3022 Lisp_Object obj
= Qnil
;
3024 if (GetKeyboardLayoutList (num_layouts
, layouts
) == num_layouts
)
3026 while (--num_layouts
>= 0)
3028 DWORD kl
= (DWORD
) layouts
[num_layouts
];
3030 obj
= Fcons (Fcons (make_number (kl
& 0xffff),
3031 make_number ((kl
>> 16) & 0xffff)),
3040 DEFUN ("w32-get-keyboard-layout", Fw32_get_keyboard_layout
,
3041 Sw32_get_keyboard_layout
, 0, 0, 0,
3042 doc
: /* Return current Windows keyboard language and layout.
3043 The return value is the cons of the language id and the layout id. */)
3046 DWORD kl
= (DWORD
) GetKeyboardLayout (dwWindowsThreadId
);
3048 return Fcons (make_number (kl
& 0xffff),
3049 make_number ((kl
>> 16) & 0xffff));
3053 DEFUN ("w32-set-keyboard-layout", Fw32_set_keyboard_layout
,
3054 Sw32_set_keyboard_layout
, 1, 1, 0,
3055 doc
: /* Make LAYOUT be the current keyboard layout for Emacs.
3056 The keyboard layout setting affects interpretation of keyboard input.
3057 If successful, the new layout id is returned, otherwise nil. */)
3058 (Lisp_Object layout
)
3062 CHECK_CONS (layout
);
3063 CHECK_NUMBER_CAR (layout
);
3064 CHECK_NUMBER_CDR (layout
);
3066 kl
= (XINT (XCAR (layout
)) & 0xffff)
3067 | (XINT (XCDR (layout
)) << 16);
3069 /* Synchronize layout with input thread. */
3070 if (dwWindowsThreadId
)
3072 if (PostThreadMessage (dwWindowsThreadId
, WM_EMACS_SETKEYBOARDLAYOUT
,
3076 GetMessage (&msg
, NULL
, WM_EMACS_DONE
, WM_EMACS_DONE
);
3078 if (msg
.wParam
== 0)
3082 else if (!ActivateKeyboardLayout ((HKL
) kl
, 0))
3085 return Fw32_get_keyboard_layout ();
3090 syms_of_ntproc (void)
3092 DEFSYM (Qhigh
, "high");
3093 DEFSYM (Qlow
, "low");
3095 defsubr (&Sw32_has_winsock
);
3096 defsubr (&Sw32_unload_winsock
);
3098 defsubr (&Sw32_short_file_name
);
3099 defsubr (&Sw32_long_file_name
);
3100 defsubr (&Sw32_set_process_priority
);
3101 defsubr (&Sw32_get_locale_info
);
3102 defsubr (&Sw32_get_current_locale_id
);
3103 defsubr (&Sw32_get_default_locale_id
);
3104 defsubr (&Sw32_get_valid_locale_ids
);
3105 defsubr (&Sw32_set_current_locale
);
3107 defsubr (&Sw32_get_console_codepage
);
3108 defsubr (&Sw32_set_console_codepage
);
3109 defsubr (&Sw32_get_console_output_codepage
);
3110 defsubr (&Sw32_set_console_output_codepage
);
3111 defsubr (&Sw32_get_valid_codepages
);
3112 defsubr (&Sw32_get_codepage_charset
);
3114 defsubr (&Sw32_get_valid_keyboard_layouts
);
3115 defsubr (&Sw32_get_keyboard_layout
);
3116 defsubr (&Sw32_set_keyboard_layout
);
3118 DEFVAR_LISP ("w32-quote-process-args", Vw32_quote_process_args
,
3119 doc
: /* Non-nil enables quoting of process arguments to ensure correct parsing.
3120 Because Windows does not directly pass argv arrays to child processes,
3121 programs have to reconstruct the argv array by parsing the command
3122 line string. For an argument to contain a space, it must be enclosed
3123 in double quotes or it will be parsed as multiple arguments.
3125 If the value is a character, that character will be used to escape any
3126 quote characters that appear, otherwise a suitable escape character
3127 will be chosen based on the type of the program. */);
3128 Vw32_quote_process_args
= Qt
;
3130 DEFVAR_LISP ("w32-start-process-show-window",
3131 Vw32_start_process_show_window
,
3132 doc
: /* When nil, new child processes hide their windows.
3133 When non-nil, they show their window in the method of their choice.
3134 This variable doesn't affect GUI applications, which will never be hidden. */);
3135 Vw32_start_process_show_window
= Qnil
;
3137 DEFVAR_LISP ("w32-start-process-share-console",
3138 Vw32_start_process_share_console
,
3139 doc
: /* When nil, new child processes are given a new console.
3140 When non-nil, they share the Emacs console; this has the limitation of
3141 allowing only one DOS subprocess to run at a time (whether started directly
3142 or indirectly by Emacs), and preventing Emacs from cleanly terminating the
3143 subprocess group, but may allow Emacs to interrupt a subprocess that doesn't
3144 otherwise respond to interrupts from Emacs. */);
3145 Vw32_start_process_share_console
= Qnil
;
3147 DEFVAR_LISP ("w32-start-process-inherit-error-mode",
3148 Vw32_start_process_inherit_error_mode
,
3149 doc
: /* When nil, new child processes revert to the default error mode.
3150 When non-nil, they inherit their error mode setting from Emacs, which stops
3151 them blocking when trying to access unmounted drives etc. */);
3152 Vw32_start_process_inherit_error_mode
= Qt
;
3154 DEFVAR_INT ("w32-pipe-read-delay", w32_pipe_read_delay
,
3155 doc
: /* Forced delay before reading subprocess output.
3156 This is done to improve the buffering of subprocess output, by
3157 avoiding the inefficiency of frequently reading small amounts of data.
3159 If positive, the value is the number of milliseconds to sleep before
3160 reading the subprocess output. If negative, the magnitude is the number
3161 of time slices to wait (effectively boosting the priority of the child
3162 process temporarily). A value of zero disables waiting entirely. */);
3163 w32_pipe_read_delay
= 50;
3165 DEFVAR_LISP ("w32-downcase-file-names", Vw32_downcase_file_names
,
3166 doc
: /* Non-nil means convert all-upper case file names to lower case.
3167 This applies when performing completions and file name expansion.
3168 Note that the value of this setting also affects remote file names,
3169 so you probably don't want to set to non-nil if you use case-sensitive
3170 filesystems via ange-ftp. */);
3171 Vw32_downcase_file_names
= Qnil
;
3174 DEFVAR_LISP ("w32-generate-fake-inodes", Vw32_generate_fake_inodes
,
3175 doc
: /* Non-nil means attempt to fake realistic inode values.
3176 This works by hashing the truename of files, and should detect
3177 aliasing between long and short (8.3 DOS) names, but can have
3178 false positives because of hash collisions. Note that determining
3179 the truename of a file can be slow. */);
3180 Vw32_generate_fake_inodes
= Qnil
;
3183 DEFVAR_LISP ("w32-get-true-file-attributes", Vw32_get_true_file_attributes
,
3184 doc
: /* Non-nil means determine accurate file attributes in `file-attributes'.
3185 This option controls whether to issue additional system calls to determine
3186 accurate link counts, file type, and ownership information. It is more
3187 useful for files on NTFS volumes, where hard links and file security are
3188 supported, than on volumes of the FAT family.
3190 Without these system calls, link count will always be reported as 1 and file
3191 ownership will be attributed to the current user.
3192 The default value `local' means only issue these system calls for files
3193 on local fixed drives. A value of nil means never issue them.
3194 Any other non-nil value means do this even on remote and removable drives
3195 where the performance impact may be noticeable even on modern hardware. */);
3196 Vw32_get_true_file_attributes
= Qlocal
;
3198 staticpro (&Vw32_valid_locale_ids
);
3199 staticpro (&Vw32_valid_codepages
);
3201 /* end of w32proc.c */