1 /* Asynchronous subprocess implementation for Win32
2 Copyright (C) 1985, 1986, 1987, 1988, 1992, 1993, 1994, 1995
3 Free Software Foundation, Inc.
4 Copyright (C) 1995 Sun Microsystems, Inc.
5 Copyright (C) 1995, 1996 Ben Wing.
7 This file is part of XEmacs.
9 XEmacs is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 You should have received a copy of the GNU General Public License
20 along with XEmacs; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
24 /* Written by Kirill M. Katsnelson <kkm@kis.ru>, April 1998 */
46 /* Arbitrary size limit for code fragments passed to run_in_other_process */
47 #define FRAGMENT_CODE_SIZE 32
49 /* Bound by winnt.el */
50 Lisp_Object Qnt_quote_process_args;
52 /* Implementation-specific data. Pointed to by Lisp_Process->process_data */
53 struct nt_process_data
58 #define NT_DATA(p) ((struct nt_process_data*)((p)->process_data))
60 /*-----------------------------------------------------------------------*/
62 /*-----------------------------------------------------------------------*/
64 /* This one breaks process abstraction. Prototype is in console-msw.h,
65 used by select_process method in event-msw.c */
67 get_nt_process_handle (struct Lisp_Process *p)
69 return (NT_DATA (p)->h_process);
72 /*-----------------------------------------------------------------------*/
73 /* Running remote threads. See Microsoft Systems Journal 1994 Number 5 */
74 /* Jeffrey Richter, Load Your 32-bit DLL into Another Process's Address..*/
75 /*-----------------------------------------------------------------------*/
85 * Allocate SIZE bytes in H_PROCESS address space. Fill in PMC used
86 * further by other routines. Return nonzero if successful.
88 * The memory in other process is allocated by creating a suspended
89 * thread. Initial stack of that thread is used as the memory
90 * block. The thread entry point is the routine ExitThread in
91 * kernel32.dll, so the allocated memory is freed just by resuming the
92 * thread, which immediately terminates after that.
96 alloc_process_memory (HANDLE h_process, size_t size,
99 LPTHREAD_START_ROUTINE adr_ExitThread =
100 (LPTHREAD_START_ROUTINE)
101 GetProcAddress (GetModuleHandle ("kernel32"), "ExitThread");
104 MEMORY_BASIC_INFORMATION mbi;
106 pmc->h_process = h_process;
107 pmc->h_thread = CreateRemoteThread (h_process, NULL, size,
108 adr_ExitThread, NULL,
109 CREATE_SUSPENDED, &dw_unused);
110 if (pmc->h_thread == NULL)
113 /* Get context, for thread's stack pointer */
114 context.ContextFlags = CONTEXT_CONTROL;
115 if (!GetThreadContext (pmc->h_thread, &context))
118 /* Determine base address of the committed range */
119 if (sizeof(mbi) != VirtualQueryEx (h_process,
121 (LPDWORD)context.Esp - 1,
122 #elif defined (_ALPHA_)
123 (LPDWORD)context.IntSp - 1,
125 #error Unknown processor architecture
130 /* Change the page protection of the allocated memory to executable,
132 if (!VirtualProtectEx (h_process, mbi.BaseAddress, size,
133 PAGE_EXECUTE_READWRITE, &dw_unused))
136 pmc->address = mbi.BaseAddress;
140 ResumeThread (pmc->h_thread);
146 free_process_memory (process_memory* pmc)
148 ResumeThread (pmc->h_thread);
152 * Run ROUTINE in the context of process determined by H_PROCESS. The
153 * routine is passed the address of DATA as parameter. The ROUTINE must
154 * not be longer than ROUTINE_CODE_SIZE bytes. DATA_SIZE is the size of
157 * Note that the code must be positionally independent, and compiled
158 * without stack checks (they cause implicit calls into CRT so will
159 * fail). DATA should not refer any data in calling process, as both
160 * routine and its data are copied into remote process. Size of data
161 * and code together should not exceed one page (4K on x86 systems).
163 * Return the value returned by ROUTINE, or (DWORD)-1 if call failed.
166 run_in_other_process (HANDLE h_process,
167 LPTHREAD_START_ROUTINE routine,
168 LPVOID data, size_t data_size)
171 CONST size_t code_size = FRAGMENT_CODE_SIZE;
172 /* Need at most 3 extra bytes of memory, for data alignment */
173 size_t total_size = code_size + data_size + 3;
178 /* Allocate memory */
179 if (!alloc_process_memory (h_process, total_size, &pm))
183 if (!WriteProcessMemory (h_process, pm.address, (LPVOID)routine,
190 remote_data = (LPBYTE)pm.address + ((code_size + 4) & ~3);
191 if (!WriteProcessMemory (h_process, remote_data, data, data_size, NULL))
197 /* Execute the remote copy of code, passing it remote data */
198 h_thread = CreateRemoteThread (h_process, NULL, 0,
199 (LPTHREAD_START_ROUTINE) pm.address,
200 remote_data, 0, &dw_unused);
201 if (h_thread == NULL)
204 /* Wait till thread finishes */
205 WaitForSingleObject (h_thread, INFINITE);
207 /* Free remote memory */
208 free_process_memory (&pm);
210 /* Return thread's exit code */
213 GetExitCodeThread (h_thread, &exit_code);
214 CloseHandle (h_thread);
219 free_process_memory (&pm);
223 /*-----------------------------------------------------------------------*/
224 /* Sending signals */
225 /*-----------------------------------------------------------------------*/
228 * We handle the following signals:
230 * SIGKILL, SIGTERM, SIGQUIT, SIGHUP - These four translate to ExitProcess
231 * executed by the remote process
232 * SIGINT - The remote process is sent CTRL_BREAK_EVENT
234 * The MSVC5.0 compiler feels free to re-order functions within a
235 * compilation unit, so we have no way of finding out the size of the
236 * following functions. Therefore these functions must not be larger than
237 * FRAGMENT_CODE_SIZE.
245 void (WINAPI *adr_ExitProcess) (UINT);
249 sigkill_proc (sigkill_data* data)
251 (*data->adr_ExitProcess)(255);
256 * Sending break or control c
260 BOOL (WINAPI *adr_GenerateConsoleCtrlEvent) (DWORD, DWORD);
265 sigint_proc (sigint_data* data)
267 return (*data->adr_GenerateConsoleCtrlEvent) (data->event, 0);
275 BOOL (WINAPI *adr_SetConsoleCtrlHandler) (LPVOID, BOOL);
279 sig_enable_proc (sig_enable_data* data)
281 (*data->adr_SetConsoleCtrlHandler) (NULL, FALSE);
286 * Send signal SIGNO to process H_PROCESS.
287 * Return nonzero if successful.
290 /* This code assigns a return value of GetProcAddress to function pointers
291 of many different types. Instead of heavy obscure casts, we just disable
292 warnings about assignments to different function pointer types. */
293 #pragma warning (disable : 4113)
296 send_signal (HANDLE h_process, int signo)
298 HMODULE h_kernel = GetModuleHandle ("kernel32");
301 assert (h_kernel != NULL);
311 d.adr_ExitProcess = GetProcAddress (h_kernel, "ExitProcess");
312 assert (d.adr_ExitProcess);
313 retval = run_in_other_process (h_process,
314 (LPTHREAD_START_ROUTINE)sigkill_proc,
321 d.adr_GenerateConsoleCtrlEvent =
322 GetProcAddress (h_kernel, "GenerateConsoleCtrlEvent");
323 assert (d.adr_GenerateConsoleCtrlEvent);
324 d.event = CTRL_C_EVENT;
325 retval = run_in_other_process (h_process,
326 (LPTHREAD_START_ROUTINE)sigint_proc,
334 return (int)retval > 0 ? 1 : 0;
338 * Enable CTRL_C_EVENT handling in a new child process
341 enable_child_signals (HANDLE h_process)
343 HMODULE h_kernel = GetModuleHandle ("kernel32");
346 assert (h_kernel != NULL);
347 d.adr_SetConsoleCtrlHandler =
348 GetProcAddress (h_kernel, "SetConsoleCtrlHandler");
349 assert (d.adr_SetConsoleCtrlHandler);
350 run_in_other_process (h_process, (LPTHREAD_START_ROUTINE)sig_enable_proc,
354 #pragma warning (default : 4113)
357 * Signal error if SIGNO is not supported
360 validate_signal_number (int signo)
362 if (signo != SIGKILL && signo != SIGTERM
363 && signo != SIGQUIT && signo != SIGINT
365 signal_simple_error ("Signal number not supported", make_int (signo));
368 /*-----------------------------------------------------------------------*/
369 /* Process methods */
370 /*-----------------------------------------------------------------------*/
373 * Allocate and initialize Lisp_Process->process_data
377 nt_alloc_process_data (struct Lisp_Process *p)
379 p->process_data = xnew_and_zero (struct nt_process_data);
383 nt_finalize_process_data (struct Lisp_Process *p, int for_disksave)
385 assert (!for_disksave);
386 if (NT_DATA(p)->h_process)
387 CloseHandle (NT_DATA(p)->h_process);
391 * Initialize XEmacs process implementation once
394 nt_init_process (void)
396 /* Initialize winsock */
398 /* Request Winsock v1.1 Note the order: (minor=1, major=1) */
399 WSAStartup (MAKEWORD (1,1), &wsa_data);
403 * Fork off a subprocess. P is a pointer to newly created subprocess
404 * object. If this function signals, the caller is responsible for
405 * deleting (and finalizing) the process object.
407 * The method must return PID of the new process, a (positive??? ####) number
408 * which fits into Lisp_Int. No return value indicates an error, the method
409 * must signal an error instead.
412 /* #### This function completely ignores Vprocess_environment */
415 signal_cannot_launch (Lisp_Object image_file, DWORD err)
417 mswindows_set_errno (err);
418 signal_simple_error_2 ("Error starting", image_file, lisp_strerror (errno));
422 nt_create_process (struct Lisp_Process *p,
423 Lisp_Object *argv, int nargv,
424 Lisp_Object program, Lisp_Object cur_dir)
426 HANDLE hmyshove, hmyslurp, hprocin, hprocout;
428 BOOL do_io, windowed;
430 /* Find out whether the application is windowed or not */
432 /* SHGetFileInfo tends to return ERROR_FILE_NOT_FOUND on most
433 errors. This leads to bogus error message. */
435 char *p = strrchr ((char *)XSTRING_DATA (program), '.');
437 (stricmp (p, ".exe") == 0 ||
438 stricmp (p, ".com") == 0 ||
439 stricmp (p, ".bat") == 0 ||
440 stricmp (p, ".cmd") == 0))
442 image_type = SHGetFileInfo ((char *)XSTRING_DATA (program), 0,NULL,
447 char progname[MAX_PATH];
448 sprintf (progname, "%s.exe", (char *)XSTRING_DATA (program));
449 image_type = SHGetFileInfo (progname, 0, NULL, 0, SHGFI_EXETYPE);
452 signal_cannot_launch (program, (GetLastError () == ERROR_FILE_NOT_FOUND
453 ? ERROR_BAD_FORMAT : GetLastError ()));
454 windowed = HIWORD (image_type) != 0;
457 /* Decide whether to do I/O on process handles, or just mark the
458 process exited immediately upon successful launching. We do I/O if the
459 process is a console one, or if it is windowed but windowed_process_io
461 do_io = !windowed || windowed_process_io ;
465 /* Create two unidirectional named pipes */
467 SECURITY_ATTRIBUTES sa;
469 sa.nLength = sizeof(sa);
470 sa.bInheritHandle = TRUE;
471 sa.lpSecurityDescriptor = NULL;
473 CreatePipe (&hprocin, &hmyshove, &sa, 0);
474 CreatePipe (&hmyslurp, &hprocout, &sa, 0);
476 /* Stupid Win32 allows to create a pipe with *both* ends either
477 inheritable or not. We need process ends inheritable, and local
478 ends not inheritable. */
479 DuplicateHandle (GetCurrentProcess(), hmyshove, GetCurrentProcess(), &htmp,
480 0, FALSE, DUPLICATE_CLOSE_SOURCE | DUPLICATE_SAME_ACCESS);
482 DuplicateHandle (GetCurrentProcess(), hmyslurp, GetCurrentProcess(), &htmp,
483 0, FALSE, DUPLICATE_CLOSE_SOURCE | DUPLICATE_SAME_ACCESS);
487 /* Convert an argv vector into Win32 style command line by a call to
488 lisp function `nt-quote-process-args' which see (in winnt.el)*/
491 Lisp_Object args_or_ret = Qnil;
494 GCPRO1 (args_or_ret);
496 for (i = 0; i < nargv; ++i)
497 args_or_ret = Fcons (*argv++, args_or_ret);
498 args_or_ret = Fnreverse (args_or_ret);
499 args_or_ret = Fcons (program, args_or_ret);
501 args_or_ret = call1 (Qnt_quote_process_args, args_or_ret);
503 if (!STRINGP (args_or_ret))
504 /* Luser wrote his/her own clever version */
505 error ("Bogus return value from `nt-quote-process-args'");
507 command_line = alloca_array (char, (XSTRING_LENGTH (program)
508 + XSTRING_LENGTH (args_or_ret) + 2));
509 strcpy (command_line, XSTRING_DATA (program));
510 strcat (command_line, " ");
511 strcat (command_line, XSTRING_DATA (args_or_ret));
513 UNGCPRO; /* args_or_ret */
519 PROCESS_INFORMATION pi;
523 si.dwFlags = STARTF_USESHOWWINDOW;
524 si.wShowWindow = windowed ? SW_SHOWNORMAL : SW_HIDE;
527 si.hStdInput = hprocin;
528 si.hStdOutput = hprocout;
529 si.hStdError = hprocout;
530 si.dwFlags |= STARTF_USESTDHANDLES;
533 err = (CreateProcess (NULL, command_line, NULL, NULL, TRUE,
534 CREATE_NEW_CONSOLE | CREATE_NEW_PROCESS_GROUP
536 NULL, (char *) XSTRING_DATA (cur_dir), &si, &pi)
537 ? 0 : GetLastError ());
541 /* These just have been inherited; we do not need a copy */
542 CloseHandle (hprocin);
543 CloseHandle (hprocout);
546 /* Handle process creation failure */
551 CloseHandle (hmyshove);
552 CloseHandle (hmyslurp);
554 signal_cannot_launch (program, GetLastError ());
557 /* The process started successfully */
560 NT_DATA(p)->h_process = pi.hProcess;
561 init_process_io_handles (p, (void*)hmyslurp, (void*)hmyshove, 0);
565 /* Indicate as if the process has exited immediately. */
566 p->status_symbol = Qexit;
567 CloseHandle (pi.hProcess);
571 enable_child_signals (pi.hProcess);
573 ResumeThread (pi.hThread);
574 CloseHandle (pi.hThread);
576 /* Hack to support Windows 95 negative pids */
577 return ((int)pi.dwProcessId < 0
578 ? -(int)pi.dwProcessId : (int)pi.dwProcessId);
583 * This method is called to update status fields of the process
584 * structure. If the process has not existed, this method is expected
587 * The method is called only for real child processes.
591 nt_update_status_if_terminated (struct Lisp_Process* p)
594 if (GetExitCodeProcess (NT_DATA(p)->h_process, &exit_code)
595 && exit_code != STILL_ACTIVE)
599 /* The exit code can be a code returned by process, or an
600 NTSTATUS value. We cannot accurately handle the latter since
601 it is a full 32 bit integer */
602 if (exit_code & 0xC0000000)
604 p->status_symbol = Qsignal;
605 p->exit_code = exit_code & 0x1FFFFFFF;
609 p->status_symbol = Qexit;
610 p->exit_code = exit_code;
616 * Stuff the entire contents of LSTREAM to the process output pipe
619 /* #### If only this function could be somehow merged with
620 unix_send_process... */
623 nt_send_process (Lisp_Object proc, struct lstream* lstream)
625 struct Lisp_Process *p = XPROCESS (proc);
627 /* use a reasonable-sized buffer (somewhere around the size of the
628 stream buffer) so as to avoid inundating the stream with blocked
630 Bufbyte chunkbuf[128];
637 chunklen = Lstream_read (lstream, chunkbuf, 128);
639 break; /* perhaps should abort() if < 0?
640 This should never happen. */
642 /* Lstream_write() will never successfully write less than the
643 amount sent in. In the worst case, it just buffers the
645 writeret = Lstream_write (XLSTREAM (DATA_OUTSTREAM(p)), chunkbuf,
647 Lstream_flush (XLSTREAM (DATA_OUTSTREAM(p)));
650 p->status_symbol = Qexit;
651 p->exit_code = ERROR_BROKEN_PIPE;
655 deactivate_process (proc);
656 error ("Broken pipe error sending to process %s; closed it",
657 XSTRING_DATA (p->name));
662 while (Lstream_was_blocked_p (XLSTREAM (p->pipe_outstream)))
664 /* Buffer is full. Wait, accepting input; that may allow
665 the program to finish doing output and read more. */
666 Faccept_process_output (Qnil, Qzero, make_int (wait_ms));
667 Lstream_flush (XLSTREAM (p->pipe_outstream));
668 wait_ms = min (1000, 2 * wait_ms);
675 * Send a signal number SIGNO to PROCESS.
676 * CURRENT_GROUP means send to the process group that currently owns
677 * the terminal being used to communicate with PROCESS.
678 * This is used for various commands in shell mode.
679 * If NOMSG is zero, insert signal-announcements into process's buffers
682 * If we can, we try to signal PROCESS by sending control characters
683 * down the pty. This allows us to signal inferiors who have changed
684 * their uid, for which killpg would return an EPERM error.
686 * The method signals an error if the given SIGNO is not valid
690 nt_kill_child_process (Lisp_Object proc, int signo,
691 int current_group, int nomsg)
693 struct Lisp_Process *p = XPROCESS (proc);
695 /* Signal error if SIGNO cannot be sent */
696 validate_signal_number (signo);
699 if (!send_signal (NT_DATA(p)->h_process, signo))
700 error ("Cannot send signal to process");
704 * Kill any process in the system given its PID.
706 * Returns zero if a signal successfully sent, or
707 * negative number upon failure
710 nt_kill_process_by_pid (int pid, int signo)
715 /* Signal error if SIGNO cannot be sent */
716 validate_signal_number (signo);
718 /* Try to open the process with required privileges */
719 h_process = OpenProcess (PROCESS_CREATE_THREAD
720 | PROCESS_QUERY_INFORMATION
721 | PROCESS_VM_OPERATION
724 if (h_process == NULL)
727 send_result = send_signal (h_process, signo);
729 CloseHandle (h_process);
731 return send_result ? 0 : -1;
734 /*-----------------------------------------------------------------------*/
735 /* Sockets connections */
736 /*-----------------------------------------------------------------------*/
739 /* #### Hey MS, how long Winsock 2 for '95 will be in beta? */
741 #define SOCK_TIMER_ID 666
742 #define XM_SOCKREPLY (WM_USER + 666)
745 get_internet_address (Lisp_Object host, struct sockaddr_in *address,
748 char buf [MAXGETHOSTSTRUCT];
753 address->sin_family = AF_INET;
755 /* First check if HOST is already a numeric address */
757 unsigned long inaddr = inet_addr (XSTRING_DATA (host));
758 if (inaddr != INADDR_NONE)
760 address->sin_addr.s_addr = inaddr;
765 /* Create a window which will receive completion messages */
766 hwnd = CreateWindow ("STATIC", NULL, WS_OVERLAPPED, 0, 0, 1, 1,
767 NULL, NULL, NULL, NULL);
770 /* Post name resolution request */
771 hasync = WSAAsyncGetHostByName (hwnd, XM_SOCKREPLY, XSTRING_DATA (host),
776 /* Set a timer to poll for quit every 250 ms */
777 SetTimer (hwnd, SOCK_TIMER_ID, 250, NULL);
782 GetMessage (&msg, hwnd, 0, 0);
783 if (msg.message == XM_SOCKREPLY)
785 /* Ok, got an answer */
786 if (WSAGETASYNCERROR(msg.lParam) == NO_ERROR)
790 else if (msg.message == WM_TIMER && msg.wParam == SOCK_TIMER_ID)
794 WSACancelAsyncRequest (hasync);
795 KillTimer (hwnd, SOCK_TIMER_ID);
796 DestroyWindow (hwnd);
800 DispatchMessage (&msg);
804 KillTimer (hwnd, SOCK_TIMER_ID);
805 DestroyWindow (hwnd);
808 /* BUF starts with struct hostent */
809 struct hostent* he = (struct hostent*) buf;
810 address->sin_addr.s_addr = *(unsigned long*)he->h_addr_list[0];
816 nt_canonicalize_host_name (Lisp_Object host)
818 struct sockaddr_in address;
820 if (!get_internet_address (host, &address, ERROR_ME_NOT))
823 if (address.sin_family == AF_INET)
824 return build_string (inet_ntoa (address.sin_addr));
829 /* open a TCP network connection to a given HOST/SERVICE. Treated
830 exactly like a normal process when reading and writing. Only
831 differences are in status display and process deletion. A network
832 connection has no PID; you cannot signal it. All you can do is
833 deactivate and close it via delete-process */
836 nt_open_network_stream (Lisp_Object name, Lisp_Object host, Lisp_Object service,
837 Lisp_Object family, void** vinfd, void** voutfd)
839 struct sockaddr_in address;
846 if (!EQ (family, Qtcpip))
847 error ("Unsupported protocol family \"%s\"",
848 string_data (symbol_name (XSYMBOL (family))));
851 port = htons ((unsigned short) XINT (service));
854 struct servent *svc_info;
855 CHECK_STRING (service);
856 svc_info = getservbyname ((char *) XSTRING_DATA (service), "tcp");
858 error ("Unknown service \"%s\"", XSTRING_DATA (service));
859 port = svc_info->s_port;
862 get_internet_address (host, &address, ERROR_ME);
863 address.sin_port = port;
865 s = socket (address.sin_family, SOCK_STREAM, 0);
867 report_file_error ("error creating socket", list1 (name));
869 /* We don't want to be blocked on connect */
871 unsigned long nonblock = 1;
872 ioctlsocket (s, FIONBIO, &nonblock);
875 retval = connect (s, (struct sockaddr *) &address, sizeof (address));
876 if (retval != NO_ERROR && WSAGetLastError() != WSAEWOULDBLOCK)
879 /* Wait while connection is established */
892 /* Poll for quit every 250 ms */
894 tv.tv_usec = 250 * 1000;
898 nsel = select (0, NULL, &fdset, &fdset, &tv);
902 /* Check: was connection successful or not? */
904 nsel = select (0, NULL, NULL, &fdset, &tv);
912 /* We are connected at this point */
914 DuplicateHandle (GetCurrentProcess(), (HANDLE)s,
915 GetCurrentProcess(), (LPHANDLE)voutfd,
916 0, FALSE, DUPLICATE_SAME_ACCESS);
921 report_file_error ("connection failed", list2 (host, name));
926 /*-----------------------------------------------------------------------*/
928 /*-----------------------------------------------------------------------*/
931 process_type_create_nt (void)
933 PROCESS_HAS_METHOD (nt, alloc_process_data);
934 PROCESS_HAS_METHOD (nt, finalize_process_data);
935 PROCESS_HAS_METHOD (nt, init_process);
936 PROCESS_HAS_METHOD (nt, create_process);
937 PROCESS_HAS_METHOD (nt, update_status_if_terminated);
938 PROCESS_HAS_METHOD (nt, send_process);
939 PROCESS_HAS_METHOD (nt, kill_child_process);
940 PROCESS_HAS_METHOD (nt, kill_process_by_pid);
942 PROCESS_HAS_METHOD (nt, canonicalize_host_name);
943 PROCESS_HAS_METHOD (nt, open_network_stream);
944 #ifdef HAVE_MULTICAST
945 #error I won't do this until '95 has winsock2
946 PROCESS_HAS_METHOD (nt, open_multicast_group);
952 syms_of_process_nt (void)
954 defsymbol (&Qnt_quote_process_args, "nt-quote-process-args");
958 vars_of_process_nt (void)