]> code.delx.au - gnu-emacs/blob - src/w32.c
(compile_pattern_1): Treat non-nil and non-string of
[gnu-emacs] / src / w32.c
1 /* Utility and Unix shadow routines for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1994, 1995, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
21
22 Geoff Voelker (voelker@cs.washington.edu) 7-29-94
23 */
24 #include <stddef.h> /* for offsetof */
25 #include <stdlib.h>
26 #include <stdio.h>
27 #include <io.h>
28 #include <errno.h>
29 #include <fcntl.h>
30 #include <ctype.h>
31 #include <signal.h>
32 #include <sys/file.h>
33 #include <sys/time.h>
34 #include <sys/utime.h>
35 #include <mbstring.h> /* for _mbspbrk */
36
37 /* must include CRT headers *before* config.h */
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43 #undef access
44 #undef chdir
45 #undef chmod
46 #undef creat
47 #undef ctime
48 #undef fopen
49 #undef link
50 #undef mkdir
51 #undef mktemp
52 #undef open
53 #undef rename
54 #undef rmdir
55 #undef unlink
56
57 #undef close
58 #undef dup
59 #undef dup2
60 #undef pipe
61 #undef read
62 #undef write
63
64 #undef strerror
65
66 #include "lisp.h"
67
68 #include <pwd.h>
69 #include <grp.h>
70
71 #ifdef __GNUC__
72 #define _ANONYMOUS_UNION
73 #define _ANONYMOUS_STRUCT
74 #endif
75 #include <windows.h>
76 #include <lmcons.h>
77 #include <shlobj.h>
78
79 #ifdef HAVE_SOCKETS /* TCP connection support, if kernel can do it */
80 #include <sys/socket.h>
81 #undef socket
82 #undef bind
83 #undef connect
84 #undef htons
85 #undef ntohs
86 #undef inet_addr
87 #undef gethostname
88 #undef gethostbyname
89 #undef getservbyname
90 #undef getpeername
91 #undef shutdown
92 #undef setsockopt
93 #undef listen
94 #undef getsockname
95 #undef accept
96 #undef recvfrom
97 #undef sendto
98 #endif
99
100 #include "w32.h"
101 #include "ndir.h"
102 #include "w32heap.h"
103 #include "systime.h"
104
105 typedef HRESULT (WINAPI * ShGetFolderPath_fn)
106 (IN HWND, IN int, IN HANDLE, IN DWORD, OUT char *);
107
108 void globals_of_w32 ();
109
110 extern Lisp_Object Vw32_downcase_file_names;
111 extern Lisp_Object Vw32_generate_fake_inodes;
112 extern Lisp_Object Vw32_get_true_file_attributes;
113 extern int w32_num_mouse_buttons;
114
115 \f
116 /* Initialization states.
117
118 WARNING: If you add any more such variables for additional APIs,
119 you MUST add initialization for them to globals_of_w32
120 below. This is because these variables might get set
121 to non-NULL values during dumping, but the dumped Emacs
122 cannot reuse those values, because it could be run on a
123 different version of the OS, where API addresses are
124 different. */
125 static BOOL g_b_init_is_windows_9x;
126 static BOOL g_b_init_open_process_token;
127 static BOOL g_b_init_get_token_information;
128 static BOOL g_b_init_lookup_account_sid;
129 static BOOL g_b_init_get_sid_identifier_authority;
130 static BOOL g_b_init_get_sid_sub_authority;
131 static BOOL g_b_init_get_sid_sub_authority_count;
132
133 /*
134 BEGIN: Wrapper functions around OpenProcessToken
135 and other functions in advapi32.dll that are only
136 supported in Windows NT / 2k / XP
137 */
138 /* ** Function pointer typedefs ** */
139 typedef BOOL (WINAPI * OpenProcessToken_Proc) (
140 HANDLE ProcessHandle,
141 DWORD DesiredAccess,
142 PHANDLE TokenHandle);
143 typedef BOOL (WINAPI * GetTokenInformation_Proc) (
144 HANDLE TokenHandle,
145 TOKEN_INFORMATION_CLASS TokenInformationClass,
146 LPVOID TokenInformation,
147 DWORD TokenInformationLength,
148 PDWORD ReturnLength);
149 typedef BOOL (WINAPI * GetProcessTimes_Proc) (
150 HANDLE process_handle,
151 LPFILETIME creation_time,
152 LPFILETIME exit_time,
153 LPFILETIME kernel_time,
154 LPFILETIME user_time);
155
156 GetProcessTimes_Proc get_process_times_fn = NULL;
157
158 #ifdef _UNICODE
159 const char * const LookupAccountSid_Name = "LookupAccountSidW";
160 #else
161 const char * const LookupAccountSid_Name = "LookupAccountSidA";
162 #endif
163 typedef BOOL (WINAPI * LookupAccountSid_Proc) (
164 LPCTSTR lpSystemName,
165 PSID Sid,
166 LPTSTR Name,
167 LPDWORD cbName,
168 LPTSTR DomainName,
169 LPDWORD cbDomainName,
170 PSID_NAME_USE peUse);
171 typedef PSID_IDENTIFIER_AUTHORITY (WINAPI * GetSidIdentifierAuthority_Proc) (
172 PSID pSid);
173 typedef PDWORD (WINAPI * GetSidSubAuthority_Proc) (
174 PSID pSid,
175 DWORD n);
176 typedef PUCHAR (WINAPI * GetSidSubAuthorityCount_Proc) (
177 PSID pSid);
178
179
180 /* ** A utility function ** */
181 static BOOL
182 is_windows_9x ()
183 {
184 static BOOL s_b_ret=0;
185 OSVERSIONINFO os_ver;
186 if (g_b_init_is_windows_9x == 0)
187 {
188 g_b_init_is_windows_9x = 1;
189 ZeroMemory(&os_ver, sizeof(OSVERSIONINFO));
190 os_ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
191 if (GetVersionEx (&os_ver))
192 {
193 s_b_ret = (os_ver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS);
194 }
195 }
196 return s_b_ret;
197 }
198
199 /* Get total user and system times for get-internal-run-time.
200 Returns a list of three integers if the times are provided by the OS
201 (NT derivatives), otherwise it returns the result of current-time. */
202 Lisp_Object
203 w32_get_internal_run_time ()
204 {
205 if (get_process_times_fn)
206 {
207 FILETIME create, exit, kernel, user;
208 HANDLE proc = GetCurrentProcess();
209 if ((*get_process_times_fn) (proc, &create, &exit, &kernel, &user))
210 {
211 LARGE_INTEGER user_int, kernel_int, total;
212 int microseconds;
213 user_int.LowPart = user.dwLowDateTime;
214 user_int.HighPart = user.dwHighDateTime;
215 kernel_int.LowPart = kernel.dwLowDateTime;
216 kernel_int.HighPart = kernel.dwHighDateTime;
217 total.QuadPart = user_int.QuadPart + kernel_int.QuadPart;
218 /* FILETIME is 100 nanosecond increments, Emacs only wants
219 microsecond resolution. */
220 total.QuadPart /= 10;
221 microseconds = total.QuadPart % 1000000;
222 total.QuadPart /= 1000000;
223
224 /* Sanity check to make sure we can represent the result. */
225 if (total.HighPart == 0)
226 {
227 int secs = total.LowPart;
228
229 return list3 (make_number ((secs >> 16) & 0xffff),
230 make_number (secs & 0xffff),
231 make_number (microseconds));
232 }
233 }
234 }
235
236 return Fcurrent_time ();
237 }
238
239 /* ** The wrapper functions ** */
240
241 BOOL WINAPI open_process_token (
242 HANDLE ProcessHandle,
243 DWORD DesiredAccess,
244 PHANDLE TokenHandle)
245 {
246 static OpenProcessToken_Proc s_pfn_Open_Process_Token = NULL;
247 HMODULE hm_advapi32 = NULL;
248 if (is_windows_9x () == TRUE)
249 {
250 return FALSE;
251 }
252 if (g_b_init_open_process_token == 0)
253 {
254 g_b_init_open_process_token = 1;
255 hm_advapi32 = LoadLibrary ("Advapi32.dll");
256 s_pfn_Open_Process_Token =
257 (OpenProcessToken_Proc) GetProcAddress (hm_advapi32, "OpenProcessToken");
258 }
259 if (s_pfn_Open_Process_Token == NULL)
260 {
261 return FALSE;
262 }
263 return (
264 s_pfn_Open_Process_Token (
265 ProcessHandle,
266 DesiredAccess,
267 TokenHandle)
268 );
269 }
270
271 BOOL WINAPI get_token_information (
272 HANDLE TokenHandle,
273 TOKEN_INFORMATION_CLASS TokenInformationClass,
274 LPVOID TokenInformation,
275 DWORD TokenInformationLength,
276 PDWORD ReturnLength)
277 {
278 static GetTokenInformation_Proc s_pfn_Get_Token_Information = NULL;
279 HMODULE hm_advapi32 = NULL;
280 if (is_windows_9x () == TRUE)
281 {
282 return FALSE;
283 }
284 if (g_b_init_get_token_information == 0)
285 {
286 g_b_init_get_token_information = 1;
287 hm_advapi32 = LoadLibrary ("Advapi32.dll");
288 s_pfn_Get_Token_Information =
289 (GetTokenInformation_Proc) GetProcAddress (hm_advapi32, "GetTokenInformation");
290 }
291 if (s_pfn_Get_Token_Information == NULL)
292 {
293 return FALSE;
294 }
295 return (
296 s_pfn_Get_Token_Information (
297 TokenHandle,
298 TokenInformationClass,
299 TokenInformation,
300 TokenInformationLength,
301 ReturnLength)
302 );
303 }
304
305 BOOL WINAPI lookup_account_sid (
306 LPCTSTR lpSystemName,
307 PSID Sid,
308 LPTSTR Name,
309 LPDWORD cbName,
310 LPTSTR DomainName,
311 LPDWORD cbDomainName,
312 PSID_NAME_USE peUse)
313 {
314 static LookupAccountSid_Proc s_pfn_Lookup_Account_Sid = NULL;
315 HMODULE hm_advapi32 = NULL;
316 if (is_windows_9x () == TRUE)
317 {
318 return FALSE;
319 }
320 if (g_b_init_lookup_account_sid == 0)
321 {
322 g_b_init_lookup_account_sid = 1;
323 hm_advapi32 = LoadLibrary ("Advapi32.dll");
324 s_pfn_Lookup_Account_Sid =
325 (LookupAccountSid_Proc) GetProcAddress (hm_advapi32, LookupAccountSid_Name);
326 }
327 if (s_pfn_Lookup_Account_Sid == NULL)
328 {
329 return FALSE;
330 }
331 return (
332 s_pfn_Lookup_Account_Sid (
333 lpSystemName,
334 Sid,
335 Name,
336 cbName,
337 DomainName,
338 cbDomainName,
339 peUse)
340 );
341 }
342
343 PSID_IDENTIFIER_AUTHORITY WINAPI get_sid_identifier_authority (
344 PSID pSid)
345 {
346 static GetSidIdentifierAuthority_Proc s_pfn_Get_Sid_Identifier_Authority = NULL;
347 HMODULE hm_advapi32 = NULL;
348 if (is_windows_9x () == TRUE)
349 {
350 return NULL;
351 }
352 if (g_b_init_get_sid_identifier_authority == 0)
353 {
354 g_b_init_get_sid_identifier_authority = 1;
355 hm_advapi32 = LoadLibrary ("Advapi32.dll");
356 s_pfn_Get_Sid_Identifier_Authority =
357 (GetSidIdentifierAuthority_Proc) GetProcAddress (
358 hm_advapi32, "GetSidIdentifierAuthority");
359 }
360 if (s_pfn_Get_Sid_Identifier_Authority == NULL)
361 {
362 return NULL;
363 }
364 return (s_pfn_Get_Sid_Identifier_Authority (pSid));
365 }
366
367 PDWORD WINAPI get_sid_sub_authority (
368 PSID pSid,
369 DWORD n)
370 {
371 static GetSidSubAuthority_Proc s_pfn_Get_Sid_Sub_Authority = NULL;
372 static DWORD zero = 0U;
373 HMODULE hm_advapi32 = NULL;
374 if (is_windows_9x () == TRUE)
375 {
376 return &zero;
377 }
378 if (g_b_init_get_sid_sub_authority == 0)
379 {
380 g_b_init_get_sid_sub_authority = 1;
381 hm_advapi32 = LoadLibrary ("Advapi32.dll");
382 s_pfn_Get_Sid_Sub_Authority =
383 (GetSidSubAuthority_Proc) GetProcAddress (
384 hm_advapi32, "GetSidSubAuthority");
385 }
386 if (s_pfn_Get_Sid_Sub_Authority == NULL)
387 {
388 return &zero;
389 }
390 return (s_pfn_Get_Sid_Sub_Authority (pSid, n));
391 }
392
393 PUCHAR WINAPI get_sid_sub_authority_count (
394 PSID pSid)
395 {
396 static GetSidSubAuthorityCount_Proc s_pfn_Get_Sid_Sub_Authority_Count = NULL;
397 static UCHAR zero = 0U;
398 HMODULE hm_advapi32 = NULL;
399 if (is_windows_9x () == TRUE)
400 {
401 return &zero;
402 }
403 if (g_b_init_get_sid_sub_authority_count == 0)
404 {
405 g_b_init_get_sid_sub_authority_count = 1;
406 hm_advapi32 = LoadLibrary ("Advapi32.dll");
407 s_pfn_Get_Sid_Sub_Authority_Count =
408 (GetSidSubAuthorityCount_Proc) GetProcAddress (
409 hm_advapi32, "GetSidSubAuthorityCount");
410 }
411 if (s_pfn_Get_Sid_Sub_Authority_Count == NULL)
412 {
413 return &zero;
414 }
415 return (s_pfn_Get_Sid_Sub_Authority_Count (pSid));
416 }
417
418 /*
419 END: Wrapper functions around OpenProcessToken
420 and other functions in advapi32.dll that are only
421 supported in Windows NT / 2k / XP
422 */
423
424 \f
425 /* Equivalent of strerror for W32 error codes. */
426 char *
427 w32_strerror (int error_no)
428 {
429 static char buf[500];
430
431 if (error_no == 0)
432 error_no = GetLastError ();
433
434 buf[0] = '\0';
435 if (!FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL,
436 error_no,
437 0, /* choose most suitable language */
438 buf, sizeof (buf), NULL))
439 sprintf (buf, "w32 error %u", error_no);
440 return buf;
441 }
442
443 /* Return 1 if P is a valid pointer to an object of size SIZE. Return
444 0 if P is NOT a valid pointer. Return -1 if we cannot validate P.
445
446 This is called from alloc.c:valid_pointer_p. */
447 int
448 w32_valid_pointer_p (void *p, int size)
449 {
450 SIZE_T done;
451 HANDLE h = OpenProcess (PROCESS_VM_READ, FALSE, GetCurrentProcessId ());
452
453 if (h)
454 {
455 unsigned char *buf = alloca (size);
456 int retval = ReadProcessMemory (h, p, buf, size, &done);
457
458 CloseHandle (h);
459 return retval;
460 }
461 else
462 return -1;
463 }
464
465 static char startup_dir[MAXPATHLEN];
466
467 /* Get the current working directory. */
468 char *
469 getwd (char *dir)
470 {
471 #if 0
472 if (GetCurrentDirectory (MAXPATHLEN, dir) > 0)
473 return dir;
474 return NULL;
475 #else
476 /* Emacs doesn't actually change directory itself, and we want to
477 force our real wd to be where emacs.exe is to avoid unnecessary
478 conflicts when trying to rename or delete directories. */
479 strcpy (dir, startup_dir);
480 return dir;
481 #endif
482 }
483
484 #ifndef HAVE_SOCKETS
485 /* Emulate gethostname. */
486 int
487 gethostname (char *buffer, int size)
488 {
489 /* NT only allows small host names, so the buffer is
490 certainly large enough. */
491 return !GetComputerName (buffer, &size);
492 }
493 #endif /* HAVE_SOCKETS */
494
495 /* Emulate getloadavg. */
496 int
497 getloadavg (double loadavg[], int nelem)
498 {
499 int i;
500
501 /* A faithful emulation is going to have to be saved for a rainy day. */
502 for (i = 0; i < nelem; i++)
503 {
504 loadavg[i] = 0.0;
505 }
506 return i;
507 }
508
509 /* Emulate getpwuid, getpwnam and others. */
510
511 #define PASSWD_FIELD_SIZE 256
512
513 static char the_passwd_name[PASSWD_FIELD_SIZE];
514 static char the_passwd_passwd[PASSWD_FIELD_SIZE];
515 static char the_passwd_gecos[PASSWD_FIELD_SIZE];
516 static char the_passwd_dir[PASSWD_FIELD_SIZE];
517 static char the_passwd_shell[PASSWD_FIELD_SIZE];
518
519 static struct passwd the_passwd =
520 {
521 the_passwd_name,
522 the_passwd_passwd,
523 0,
524 0,
525 0,
526 the_passwd_gecos,
527 the_passwd_dir,
528 the_passwd_shell,
529 };
530
531 static struct group the_group =
532 {
533 /* There are no groups on NT, so we just return "root" as the
534 group name. */
535 "root",
536 };
537
538 int
539 getuid ()
540 {
541 return the_passwd.pw_uid;
542 }
543
544 int
545 geteuid ()
546 {
547 /* I could imagine arguing for checking to see whether the user is
548 in the Administrators group and returning a UID of 0 for that
549 case, but I don't know how wise that would be in the long run. */
550 return getuid ();
551 }
552
553 int
554 getgid ()
555 {
556 return the_passwd.pw_gid;
557 }
558
559 int
560 getegid ()
561 {
562 return getgid ();
563 }
564
565 struct passwd *
566 getpwuid (int uid)
567 {
568 if (uid == the_passwd.pw_uid)
569 return &the_passwd;
570 return NULL;
571 }
572
573 struct group *
574 getgrgid (gid_t gid)
575 {
576 return &the_group;
577 }
578
579 struct passwd *
580 getpwnam (char *name)
581 {
582 struct passwd *pw;
583
584 pw = getpwuid (getuid ());
585 if (!pw)
586 return pw;
587
588 if (stricmp (name, pw->pw_name))
589 return NULL;
590
591 return pw;
592 }
593
594 void
595 init_user_info ()
596 {
597 /* Find the user's real name by opening the process token and
598 looking up the name associated with the user-sid in that token.
599
600 Use the relative portion of the identifier authority value from
601 the user-sid as the user id value (same for group id using the
602 primary group sid from the process token). */
603
604 char name[UNLEN+1], domain[1025];
605 DWORD length = sizeof (name), dlength = sizeof (domain), trash;
606 HANDLE token = NULL;
607 SID_NAME_USE user_type;
608 unsigned char buf[1024];
609 TOKEN_USER user_token;
610 TOKEN_PRIMARY_GROUP group_token;
611
612 if (open_process_token (GetCurrentProcess (), TOKEN_QUERY, &token)
613 && get_token_information (token, TokenUser,
614 (PVOID)buf, sizeof (buf), &trash)
615 && (memcpy (&user_token, buf, sizeof (user_token)),
616 lookup_account_sid (NULL, user_token.User.Sid, name, &length,
617 domain, &dlength, &user_type)))
618 {
619 strcpy (the_passwd.pw_name, name);
620 /* Determine a reasonable uid value. */
621 if (stricmp ("administrator", name) == 0)
622 {
623 the_passwd.pw_uid = 500; /* well-known Administrator uid */
624 the_passwd.pw_gid = 513; /* well-known None gid */
625 }
626 else
627 {
628 /* Use the last sub-authority value of the RID, the relative
629 portion of the SID, as user/group ID. */
630 DWORD n_subauthorities =
631 *get_sid_sub_authority_count (user_token.User.Sid);
632
633 if (n_subauthorities < 1)
634 the_passwd.pw_uid = 0; /* the "World" RID */
635 else
636 {
637 the_passwd.pw_uid =
638 *get_sid_sub_authority (user_token.User.Sid,
639 n_subauthorities - 1);
640 }
641
642 /* Get group id */
643 if (get_token_information (token, TokenPrimaryGroup,
644 (PVOID)buf, sizeof (buf), &trash))
645 {
646 memcpy (&group_token, buf, sizeof (group_token));
647 n_subauthorities =
648 *get_sid_sub_authority_count (group_token.PrimaryGroup);
649
650 if (n_subauthorities < 1)
651 the_passwd.pw_gid = 0; /* the "World" RID */
652 else
653 {
654 the_passwd.pw_gid =
655 *get_sid_sub_authority (group_token.PrimaryGroup,
656 n_subauthorities - 1);
657 }
658 }
659 else
660 the_passwd.pw_gid = the_passwd.pw_uid;
661 }
662 }
663 /* If security calls are not supported (presumably because we
664 are running under Windows 95), fallback to this. */
665 else if (GetUserName (name, &length))
666 {
667 strcpy (the_passwd.pw_name, name);
668 if (stricmp ("administrator", name) == 0)
669 the_passwd.pw_uid = 0;
670 else
671 the_passwd.pw_uid = 123;
672 the_passwd.pw_gid = the_passwd.pw_uid;
673 }
674 else
675 {
676 strcpy (the_passwd.pw_name, "unknown");
677 the_passwd.pw_uid = 123;
678 the_passwd.pw_gid = 123;
679 }
680
681 /* Ensure HOME and SHELL are defined. */
682 if (getenv ("HOME") == NULL)
683 abort ();
684 if (getenv ("SHELL") == NULL)
685 abort ();
686
687 /* Set dir and shell from environment variables. */
688 strcpy (the_passwd.pw_dir, getenv ("HOME"));
689 strcpy (the_passwd.pw_shell, getenv ("SHELL"));
690
691 if (token)
692 CloseHandle (token);
693 }
694
695 int
696 random ()
697 {
698 /* rand () on NT gives us 15 random bits...hack together 30 bits. */
699 return ((rand () << 15) | rand ());
700 }
701
702 void
703 srandom (int seed)
704 {
705 srand (seed);
706 }
707
708
709 /* Normalize filename by converting all path separators to
710 the specified separator. Also conditionally convert upper
711 case path name components to lower case. */
712
713 static void
714 normalize_filename (fp, path_sep)
715 register char *fp;
716 char path_sep;
717 {
718 char sep;
719 char *elem;
720
721 /* Always lower-case drive letters a-z, even if the filesystem
722 preserves case in filenames.
723 This is so filenames can be compared by string comparison
724 functions that are case-sensitive. Even case-preserving filesystems
725 do not distinguish case in drive letters. */
726 if (fp[1] == ':' && *fp >= 'A' && *fp <= 'Z')
727 {
728 *fp += 'a' - 'A';
729 fp += 2;
730 }
731
732 if (NILP (Vw32_downcase_file_names))
733 {
734 while (*fp)
735 {
736 if (*fp == '/' || *fp == '\\')
737 *fp = path_sep;
738 fp++;
739 }
740 return;
741 }
742
743 sep = path_sep; /* convert to this path separator */
744 elem = fp; /* start of current path element */
745
746 do {
747 if (*fp >= 'a' && *fp <= 'z')
748 elem = 0; /* don't convert this element */
749
750 if (*fp == 0 || *fp == ':')
751 {
752 sep = *fp; /* restore current separator (or 0) */
753 *fp = '/'; /* after conversion of this element */
754 }
755
756 if (*fp == '/' || *fp == '\\')
757 {
758 if (elem && elem != fp)
759 {
760 *fp = 0; /* temporary end of string */
761 _strlwr (elem); /* while we convert to lower case */
762 }
763 *fp = sep; /* convert (or restore) path separator */
764 elem = fp + 1; /* next element starts after separator */
765 sep = path_sep;
766 }
767 } while (*fp++);
768 }
769
770 /* Destructively turn backslashes into slashes. */
771 void
772 dostounix_filename (p)
773 register char *p;
774 {
775 normalize_filename (p, '/');
776 }
777
778 /* Destructively turn slashes into backslashes. */
779 void
780 unixtodos_filename (p)
781 register char *p;
782 {
783 normalize_filename (p, '\\');
784 }
785
786 /* Remove all CR's that are followed by a LF.
787 (From msdos.c...probably should figure out a way to share it,
788 although this code isn't going to ever change.) */
789 int
790 crlf_to_lf (n, buf)
791 register int n;
792 register unsigned char *buf;
793 {
794 unsigned char *np = buf;
795 unsigned char *startp = buf;
796 unsigned char *endp = buf + n;
797
798 if (n == 0)
799 return n;
800 while (buf < endp - 1)
801 {
802 if (*buf == 0x0d)
803 {
804 if (*(++buf) != 0x0a)
805 *np++ = 0x0d;
806 }
807 else
808 *np++ = *buf++;
809 }
810 if (buf < endp)
811 *np++ = *buf++;
812 return np - startp;
813 }
814
815 /* Parse the root part of file name, if present. Return length and
816 optionally store pointer to char after root. */
817 static int
818 parse_root (char * name, char ** pPath)
819 {
820 char * start = name;
821
822 if (name == NULL)
823 return 0;
824
825 /* find the root name of the volume if given */
826 if (isalpha (name[0]) && name[1] == ':')
827 {
828 /* skip past drive specifier */
829 name += 2;
830 if (IS_DIRECTORY_SEP (name[0]))
831 name++;
832 }
833 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
834 {
835 int slashes = 2;
836 name += 2;
837 do
838 {
839 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
840 break;
841 name++;
842 }
843 while ( *name );
844 if (IS_DIRECTORY_SEP (name[0]))
845 name++;
846 }
847
848 if (pPath)
849 *pPath = name;
850
851 return name - start;
852 }
853
854 /* Get long base name for name; name is assumed to be absolute. */
855 static int
856 get_long_basename (char * name, char * buf, int size)
857 {
858 WIN32_FIND_DATA find_data;
859 HANDLE dir_handle;
860 int len = 0;
861
862 /* must be valid filename, no wild cards or other invalid characters */
863 if (_mbspbrk (name, "*?|<>\""))
864 return 0;
865
866 dir_handle = FindFirstFile (name, &find_data);
867 if (dir_handle != INVALID_HANDLE_VALUE)
868 {
869 if ((len = strlen (find_data.cFileName)) < size)
870 memcpy (buf, find_data.cFileName, len + 1);
871 else
872 len = 0;
873 FindClose (dir_handle);
874 }
875 return len;
876 }
877
878 /* Get long name for file, if possible (assumed to be absolute). */
879 BOOL
880 w32_get_long_filename (char * name, char * buf, int size)
881 {
882 char * o = buf;
883 char * p;
884 char * q;
885 char full[ MAX_PATH ];
886 int len;
887
888 len = strlen (name);
889 if (len >= MAX_PATH)
890 return FALSE;
891
892 /* Use local copy for destructive modification. */
893 memcpy (full, name, len+1);
894 unixtodos_filename (full);
895
896 /* Copy root part verbatim. */
897 len = parse_root (full, &p);
898 memcpy (o, full, len);
899 o += len;
900 *o = '\0';
901 size -= len;
902
903 while (p != NULL && *p)
904 {
905 q = p;
906 p = strchr (q, '\\');
907 if (p) *p = '\0';
908 len = get_long_basename (full, o, size);
909 if (len > 0)
910 {
911 o += len;
912 size -= len;
913 if (p != NULL)
914 {
915 *p++ = '\\';
916 if (size < 2)
917 return FALSE;
918 *o++ = '\\';
919 size--;
920 *o = '\0';
921 }
922 }
923 else
924 return FALSE;
925 }
926
927 return TRUE;
928 }
929
930 int
931 is_unc_volume (const char *filename)
932 {
933 const char *ptr = filename;
934
935 if (!IS_DIRECTORY_SEP (ptr[0]) || !IS_DIRECTORY_SEP (ptr[1]) || !ptr[2])
936 return 0;
937
938 if (_mbspbrk (ptr + 2, "*?|<>\"\\/"))
939 return 0;
940
941 return 1;
942 }
943
944 /* Routines that are no-ops on NT but are defined to get Emacs to compile. */
945
946 int
947 sigsetmask (int signal_mask)
948 {
949 return 0;
950 }
951
952 int
953 sigmask (int sig)
954 {
955 return 0;
956 }
957
958 int
959 sigblock (int sig)
960 {
961 return 0;
962 }
963
964 int
965 sigunblock (int sig)
966 {
967 return 0;
968 }
969
970 int
971 setpgrp (int pid, int gid)
972 {
973 return 0;
974 }
975
976 int
977 alarm (int seconds)
978 {
979 return 0;
980 }
981
982 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
983
984 LPBYTE
985 w32_get_resource (key, lpdwtype)
986 char *key;
987 LPDWORD lpdwtype;
988 {
989 LPBYTE lpvalue;
990 HKEY hrootkey = NULL;
991 DWORD cbData;
992
993 /* Check both the current user and the local machine to see if
994 we have any resources. */
995
996 if (RegOpenKeyEx (HKEY_CURRENT_USER, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
997 {
998 lpvalue = NULL;
999
1000 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS
1001 && (lpvalue = (LPBYTE) xmalloc (cbData)) != NULL
1002 && RegQueryValueEx (hrootkey, key, NULL, lpdwtype, lpvalue, &cbData) == ERROR_SUCCESS)
1003 {
1004 RegCloseKey (hrootkey);
1005 return (lpvalue);
1006 }
1007
1008 if (lpvalue) xfree (lpvalue);
1009
1010 RegCloseKey (hrootkey);
1011 }
1012
1013 if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
1014 {
1015 lpvalue = NULL;
1016
1017 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS
1018 && (lpvalue = (LPBYTE) xmalloc (cbData)) != NULL
1019 && RegQueryValueEx (hrootkey, key, NULL, lpdwtype, lpvalue, &cbData) == ERROR_SUCCESS)
1020 {
1021 RegCloseKey (hrootkey);
1022 return (lpvalue);
1023 }
1024
1025 if (lpvalue) xfree (lpvalue);
1026
1027 RegCloseKey (hrootkey);
1028 }
1029
1030 return (NULL);
1031 }
1032
1033 char *get_emacs_configuration (void);
1034 extern Lisp_Object Vsystem_configuration;
1035
1036 void
1037 init_environment (char ** argv)
1038 {
1039 static const char * const tempdirs[] = {
1040 "$TMPDIR", "$TEMP", "$TMP", "c:/"
1041 };
1042
1043 int i;
1044
1045 const int imax = sizeof (tempdirs) / sizeof (tempdirs[0]);
1046
1047 /* Make sure they have a usable $TMPDIR. Many Emacs functions use
1048 temporary files and assume "/tmp" if $TMPDIR is unset, which
1049 will break on DOS/Windows. Refuse to work if we cannot find
1050 a directory, not even "c:/", usable for that purpose. */
1051 for (i = 0; i < imax ; i++)
1052 {
1053 const char *tmp = tempdirs[i];
1054
1055 if (*tmp == '$')
1056 tmp = getenv (tmp + 1);
1057 /* Note that `access' can lie to us if the directory resides on a
1058 read-only filesystem, like CD-ROM or a write-protected floppy.
1059 The only way to be really sure is to actually create a file and
1060 see if it succeeds. But I think that's too much to ask. */
1061 if (tmp && _access (tmp, D_OK) == 0)
1062 {
1063 char * var = alloca (strlen (tmp) + 8);
1064 sprintf (var, "TMPDIR=%s", tmp);
1065 _putenv (strdup (var));
1066 break;
1067 }
1068 }
1069 if (i >= imax)
1070 cmd_error_internal
1071 (Fcons (Qerror,
1072 Fcons (build_string ("no usable temporary directories found!!"),
1073 Qnil)),
1074 "While setting TMPDIR: ");
1075
1076 /* Check for environment variables and use registry settings if they
1077 don't exist. Fallback on default values where applicable. */
1078 {
1079 int i;
1080 LPBYTE lpval;
1081 DWORD dwType;
1082 char locale_name[32];
1083 struct stat ignored;
1084 char default_home[MAX_PATH];
1085
1086 static const struct env_entry
1087 {
1088 char * name;
1089 char * def_value;
1090 } dflt_envvars[] =
1091 {
1092 {"HOME", "C:/"},
1093 {"PRELOAD_WINSOCK", NULL},
1094 {"emacs_dir", "C:/emacs"},
1095 {"EMACSLOADPATH", "%emacs_dir%/site-lisp;%emacs_dir%/../site-lisp;%emacs_dir%/lisp;%emacs_dir%/leim"},
1096 {"SHELL", "%emacs_dir%/bin/cmdproxy.exe"},
1097 {"EMACSDATA", "%emacs_dir%/etc"},
1098 {"EMACSPATH", "%emacs_dir%/bin"},
1099 /* We no longer set INFOPATH because Info-default-directory-list
1100 is then ignored. */
1101 /* {"INFOPATH", "%emacs_dir%/info"}, */
1102 {"EMACSDOC", "%emacs_dir%/etc"},
1103 {"TERM", "cmd"},
1104 {"LANG", NULL},
1105 };
1106
1107 #define N_ENV_VARS sizeof(dflt_envvars)/sizeof(dflt_envvars[0])
1108
1109 /* We need to copy dflt_envvars[] and work on the copy because we
1110 don't want the dumped Emacs to inherit the values of
1111 environment variables we saw during dumping (which could be on
1112 a different system). The defaults above must be left intact. */
1113 struct env_entry env_vars[N_ENV_VARS];
1114
1115 for (i = 0; i < N_ENV_VARS; i++)
1116 env_vars[i] = dflt_envvars[i];
1117
1118 /* For backwards compatibility, check if a .emacs file exists in C:/
1119 If not, then we can try to default to the appdata directory under the
1120 user's profile, which is more likely to be writable. */
1121 if (stat ("C:/.emacs", &ignored) < 0)
1122 {
1123 HRESULT profile_result;
1124 /* Dynamically load ShGetFolderPath, as it won't exist on versions
1125 of Windows 95 and NT4 that have not been updated to include
1126 MSIE 5. Also we don't link with shell32.dll by default. */
1127 HMODULE shell32_dll;
1128 ShGetFolderPath_fn get_folder_path;
1129 shell32_dll = GetModuleHandle ("shell32.dll");
1130 get_folder_path = (ShGetFolderPath_fn)
1131 GetProcAddress (shell32_dll, "SHGetFolderPathA");
1132
1133 if (get_folder_path != NULL)
1134 {
1135 profile_result = get_folder_path (NULL, CSIDL_APPDATA, NULL,
1136 0, default_home);
1137
1138 /* If we can't get the appdata dir, revert to old behaviour. */
1139 if (profile_result == S_OK)
1140 env_vars[0].def_value = default_home;
1141 }
1142
1143 /* Unload shell32.dll, it is not needed anymore. */
1144 FreeLibrary (shell32_dll);
1145 }
1146
1147 /* Get default locale info and use it for LANG. */
1148 if (GetLocaleInfo (LOCALE_USER_DEFAULT,
1149 LOCALE_SABBREVLANGNAME | LOCALE_USE_CP_ACP,
1150 locale_name, sizeof (locale_name)))
1151 {
1152 for (i = 0; i < N_ENV_VARS; i++)
1153 {
1154 if (strcmp (env_vars[i].name, "LANG") == 0)
1155 {
1156 env_vars[i].def_value = locale_name;
1157 break;
1158 }
1159 }
1160 }
1161
1162 #define SET_ENV_BUF_SIZE (4 * MAX_PATH) /* to cover EMACSLOADPATH */
1163
1164 /* Treat emacs_dir specially: set it unconditionally based on our
1165 location, if it appears that we are running from the bin subdir
1166 of a standard installation. */
1167 {
1168 char *p;
1169 char modname[MAX_PATH];
1170
1171 if (!GetModuleFileName (NULL, modname, MAX_PATH))
1172 abort ();
1173 if ((p = strrchr (modname, '\\')) == NULL)
1174 abort ();
1175 *p = 0;
1176
1177 if ((p = strrchr (modname, '\\')) && stricmp (p, "\\bin") == 0)
1178 {
1179 char buf[SET_ENV_BUF_SIZE];
1180
1181 *p = 0;
1182 for (p = modname; *p; p++)
1183 if (*p == '\\') *p = '/';
1184
1185 _snprintf (buf, sizeof(buf)-1, "emacs_dir=%s", modname);
1186 _putenv (strdup (buf));
1187 }
1188 /* Handle running emacs from the build directory: src/oo-spd/i386/ */
1189
1190 /* FIXME: should use substring of get_emacs_configuration ().
1191 But I don't think the Windows build supports alpha, mips etc
1192 anymore, so have taken the easy option for now. */
1193 else if (p && stricmp (p, "\\i386") == 0)
1194 {
1195 *p = 0;
1196 p = strrchr (modname, '\\');
1197 if (p != NULL)
1198 {
1199 *p = 0;
1200 p = strrchr (modname, '\\');
1201 if (p && stricmp (p, "\\src") == 0)
1202 {
1203 char buf[SET_ENV_BUF_SIZE];
1204
1205 *p = 0;
1206 for (p = modname; *p; p++)
1207 if (*p == '\\') *p = '/';
1208
1209 _snprintf (buf, sizeof(buf)-1, "emacs_dir=%s", modname);
1210 _putenv (strdup (buf));
1211 }
1212 }
1213 }
1214 }
1215
1216 for (i = 0; i < N_ENV_VARS; i++)
1217 {
1218 if (!getenv (env_vars[i].name))
1219 {
1220 int dont_free = 0;
1221
1222 if ((lpval = w32_get_resource (env_vars[i].name, &dwType)) == NULL
1223 /* Also ignore empty environment variables. */
1224 || *lpval == 0)
1225 {
1226 if (lpval) xfree (lpval);
1227 lpval = env_vars[i].def_value;
1228 dwType = REG_EXPAND_SZ;
1229 dont_free = 1;
1230 }
1231
1232 if (lpval)
1233 {
1234 char buf1[SET_ENV_BUF_SIZE], buf2[SET_ENV_BUF_SIZE];
1235
1236 if (dwType == REG_EXPAND_SZ)
1237 ExpandEnvironmentStrings ((LPSTR) lpval, buf1, sizeof(buf1));
1238 else if (dwType == REG_SZ)
1239 strcpy (buf1, lpval);
1240 if (dwType == REG_EXPAND_SZ || dwType == REG_SZ)
1241 {
1242 _snprintf (buf2, sizeof(buf2)-1, "%s=%s", env_vars[i].name,
1243 buf1);
1244 _putenv (strdup (buf2));
1245 }
1246
1247 if (!dont_free)
1248 xfree (lpval);
1249 }
1250 }
1251 }
1252 }
1253
1254 /* Rebuild system configuration to reflect invoking system. */
1255 Vsystem_configuration = build_string (EMACS_CONFIGURATION);
1256
1257 /* Another special case: on NT, the PATH variable is actually named
1258 "Path" although cmd.exe (perhaps NT itself) arranges for
1259 environment variable lookup and setting to be case insensitive.
1260 However, Emacs assumes a fully case sensitive environment, so we
1261 need to change "Path" to "PATH" to match the expectations of
1262 various elisp packages. We do this by the sneaky method of
1263 modifying the string in the C runtime environ entry.
1264
1265 The same applies to COMSPEC. */
1266 {
1267 char ** envp;
1268
1269 for (envp = environ; *envp; envp++)
1270 if (_strnicmp (*envp, "PATH=", 5) == 0)
1271 memcpy (*envp, "PATH=", 5);
1272 else if (_strnicmp (*envp, "COMSPEC=", 8) == 0)
1273 memcpy (*envp, "COMSPEC=", 8);
1274 }
1275
1276 /* Remember the initial working directory for getwd, then make the
1277 real wd be the location of emacs.exe to avoid conflicts when
1278 renaming or deleting directories. (We also don't call chdir when
1279 running subprocesses for the same reason.) */
1280 if (!GetCurrentDirectory (MAXPATHLEN, startup_dir))
1281 abort ();
1282
1283 {
1284 char *p;
1285 static char modname[MAX_PATH];
1286
1287 if (!GetModuleFileName (NULL, modname, MAX_PATH))
1288 abort ();
1289 if ((p = strrchr (modname, '\\')) == NULL)
1290 abort ();
1291 *p = 0;
1292
1293 SetCurrentDirectory (modname);
1294
1295 /* Ensure argv[0] has the full path to Emacs. */
1296 *p = '\\';
1297 argv[0] = modname;
1298 }
1299
1300 /* Determine if there is a middle mouse button, to allow parse_button
1301 to decide whether right mouse events should be mouse-2 or
1302 mouse-3. */
1303 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
1304
1305 init_user_info ();
1306 }
1307
1308 char *
1309 emacs_root_dir (void)
1310 {
1311 static char root_dir[FILENAME_MAX];
1312 const char *p;
1313
1314 p = getenv ("emacs_dir");
1315 if (p == NULL)
1316 abort ();
1317 strcpy (root_dir, p);
1318 root_dir[parse_root (root_dir, NULL)] = '\0';
1319 dostounix_filename (root_dir);
1320 return root_dir;
1321 }
1322
1323 /* We don't have scripts to automatically determine the system configuration
1324 for Emacs before it's compiled, and we don't want to have to make the
1325 user enter it, so we define EMACS_CONFIGURATION to invoke this runtime
1326 routine. */
1327
1328 char *
1329 get_emacs_configuration (void)
1330 {
1331 char *arch, *oem, *os;
1332 int build_num;
1333 static char configuration_buffer[32];
1334
1335 /* Determine the processor type. */
1336 switch (get_processor_type ())
1337 {
1338
1339 #ifdef PROCESSOR_INTEL_386
1340 case PROCESSOR_INTEL_386:
1341 case PROCESSOR_INTEL_486:
1342 case PROCESSOR_INTEL_PENTIUM:
1343 arch = "i386";
1344 break;
1345 #endif
1346
1347 #ifdef PROCESSOR_MIPS_R2000
1348 case PROCESSOR_MIPS_R2000:
1349 case PROCESSOR_MIPS_R3000:
1350 case PROCESSOR_MIPS_R4000:
1351 arch = "mips";
1352 break;
1353 #endif
1354
1355 #ifdef PROCESSOR_ALPHA_21064
1356 case PROCESSOR_ALPHA_21064:
1357 arch = "alpha";
1358 break;
1359 #endif
1360
1361 default:
1362 arch = "unknown";
1363 break;
1364 }
1365
1366 /* Use the OEM field to reflect the compiler/library combination. */
1367 #ifdef _MSC_VER
1368 #define COMPILER_NAME "msvc"
1369 #else
1370 #ifdef __GNUC__
1371 #define COMPILER_NAME "mingw"
1372 #else
1373 #define COMPILER_NAME "unknown"
1374 #endif
1375 #endif
1376 oem = COMPILER_NAME;
1377
1378 switch (osinfo_cache.dwPlatformId) {
1379 case VER_PLATFORM_WIN32_NT:
1380 os = "nt";
1381 build_num = osinfo_cache.dwBuildNumber;
1382 break;
1383 case VER_PLATFORM_WIN32_WINDOWS:
1384 if (osinfo_cache.dwMinorVersion == 0) {
1385 os = "windows95";
1386 } else {
1387 os = "windows98";
1388 }
1389 build_num = LOWORD (osinfo_cache.dwBuildNumber);
1390 break;
1391 case VER_PLATFORM_WIN32s:
1392 /* Not supported, should not happen. */
1393 os = "windows32s";
1394 build_num = LOWORD (osinfo_cache.dwBuildNumber);
1395 break;
1396 default:
1397 os = "unknown";
1398 build_num = 0;
1399 break;
1400 }
1401
1402 if (osinfo_cache.dwPlatformId == VER_PLATFORM_WIN32_NT) {
1403 sprintf (configuration_buffer, "%s-%s-%s%d.%d.%d", arch, oem, os,
1404 get_w32_major_version (), get_w32_minor_version (), build_num);
1405 } else {
1406 sprintf (configuration_buffer, "%s-%s-%s.%d", arch, oem, os, build_num);
1407 }
1408
1409 return configuration_buffer;
1410 }
1411
1412 char *
1413 get_emacs_configuration_options (void)
1414 {
1415 static char options_buffer[256];
1416
1417 /* Work out the effective configure options for this build. */
1418 #ifdef _MSC_VER
1419 #define COMPILER_VERSION "--with-msvc (%d.%02d)", _MSC_VER / 100, _MSC_VER % 100
1420 #else
1421 #ifdef __GNUC__
1422 #define COMPILER_VERSION "--with-gcc (%d.%d)", __GNUC__, __GNUC_MINOR__
1423 #else
1424 #define COMPILER_VERSION ""
1425 #endif
1426 #endif
1427
1428 sprintf (options_buffer, COMPILER_VERSION);
1429 #ifdef EMACSDEBUG
1430 strcat (options_buffer, " --no-opt");
1431 #endif
1432 #ifdef USER_CFLAGS
1433 strcat (options_buffer, " --cflags");
1434 strcat (options_buffer, USER_CFLAGS);
1435 #endif
1436 #ifdef USER_LDFLAGS
1437 strcat (options_buffer, " --ldflags");
1438 strcat (options_buffer, USER_LDFLAGS);
1439 #endif
1440 return options_buffer;
1441 }
1442
1443
1444 #include <sys/timeb.h>
1445
1446 /* Emulate gettimeofday (Ulrich Leodolter, 1/11/95). */
1447 void
1448 gettimeofday (struct timeval *tv, struct timezone *tz)
1449 {
1450 struct _timeb tb;
1451 _ftime (&tb);
1452
1453 tv->tv_sec = tb.time;
1454 tv->tv_usec = tb.millitm * 1000L;
1455 if (tz)
1456 {
1457 tz->tz_minuteswest = tb.timezone; /* minutes west of Greenwich */
1458 tz->tz_dsttime = tb.dstflag; /* type of dst correction */
1459 }
1460 }
1461
1462 /* ------------------------------------------------------------------------- */
1463 /* IO support and wrapper functions for W32 API. */
1464 /* ------------------------------------------------------------------------- */
1465
1466 /* Place a wrapper around the MSVC version of ctime. It returns NULL
1467 on network directories, so we handle that case here.
1468 (Ulrich Leodolter, 1/11/95). */
1469 char *
1470 sys_ctime (const time_t *t)
1471 {
1472 char *str = (char *) ctime (t);
1473 return (str ? str : "Sun Jan 01 00:00:00 1970");
1474 }
1475
1476 /* Emulate sleep...we could have done this with a define, but that
1477 would necessitate including windows.h in the files that used it.
1478 This is much easier. */
1479 void
1480 sys_sleep (int seconds)
1481 {
1482 Sleep (seconds * 1000);
1483 }
1484
1485 /* Internal MSVC functions for low-level descriptor munging */
1486 extern int __cdecl _set_osfhnd (int fd, long h);
1487 extern int __cdecl _free_osfhnd (int fd);
1488
1489 /* parallel array of private info on file handles */
1490 filedesc fd_info [ MAXDESC ];
1491
1492 typedef struct volume_info_data {
1493 struct volume_info_data * next;
1494
1495 /* time when info was obtained */
1496 DWORD timestamp;
1497
1498 /* actual volume info */
1499 char * root_dir;
1500 DWORD serialnum;
1501 DWORD maxcomp;
1502 DWORD flags;
1503 char * name;
1504 char * type;
1505 } volume_info_data;
1506
1507 /* Global referenced by various functions. */
1508 static volume_info_data volume_info;
1509
1510 /* Vector to indicate which drives are local and fixed (for which cached
1511 data never expires). */
1512 static BOOL fixed_drives[26];
1513
1514 /* Consider cached volume information to be stale if older than 10s,
1515 at least for non-local drives. Info for fixed drives is never stale. */
1516 #define DRIVE_INDEX( c ) ( (c) <= 'Z' ? (c) - 'A' : (c) - 'a' )
1517 #define VOLINFO_STILL_VALID( root_dir, info ) \
1518 ( ( isalpha (root_dir[0]) && \
1519 fixed_drives[ DRIVE_INDEX (root_dir[0]) ] ) \
1520 || GetTickCount () - info->timestamp < 10000 )
1521
1522 /* Cache support functions. */
1523
1524 /* Simple linked list with linear search is sufficient. */
1525 static volume_info_data *volume_cache = NULL;
1526
1527 static volume_info_data *
1528 lookup_volume_info (char * root_dir)
1529 {
1530 volume_info_data * info;
1531
1532 for (info = volume_cache; info; info = info->next)
1533 if (stricmp (info->root_dir, root_dir) == 0)
1534 break;
1535 return info;
1536 }
1537
1538 static void
1539 add_volume_info (char * root_dir, volume_info_data * info)
1540 {
1541 info->root_dir = xstrdup (root_dir);
1542 info->next = volume_cache;
1543 volume_cache = info;
1544 }
1545
1546
1547 /* Wrapper for GetVolumeInformation, which uses caching to avoid
1548 performance penalty (~2ms on 486 for local drives, 7.5ms for local
1549 cdrom drive, ~5-10ms or more for remote drives on LAN). */
1550 volume_info_data *
1551 GetCachedVolumeInformation (char * root_dir)
1552 {
1553 volume_info_data * info;
1554 char default_root[ MAX_PATH ];
1555
1556 /* NULL for root_dir means use root from current directory. */
1557 if (root_dir == NULL)
1558 {
1559 if (GetCurrentDirectory (MAX_PATH, default_root) == 0)
1560 return NULL;
1561 parse_root (default_root, &root_dir);
1562 *root_dir = 0;
1563 root_dir = default_root;
1564 }
1565
1566 /* Local fixed drives can be cached permanently. Removable drives
1567 cannot be cached permanently, since the volume name and serial
1568 number (if nothing else) can change. Remote drives should be
1569 treated as if they are removable, since there is no sure way to
1570 tell whether they are or not. Also, the UNC association of drive
1571 letters mapped to remote volumes can be changed at any time (even
1572 by other processes) without notice.
1573
1574 As a compromise, so we can benefit from caching info for remote
1575 volumes, we use a simple expiry mechanism to invalidate cache
1576 entries that are more than ten seconds old. */
1577
1578 #if 0
1579 /* No point doing this, because WNetGetConnection is even slower than
1580 GetVolumeInformation, consistently taking ~50ms on a 486 (FWIW,
1581 GetDriveType is about the only call of this type which does not
1582 involve network access, and so is extremely quick). */
1583
1584 /* Map drive letter to UNC if remote. */
1585 if ( isalpha( root_dir[0] ) && !fixed[ DRIVE_INDEX( root_dir[0] ) ] )
1586 {
1587 char remote_name[ 256 ];
1588 char drive[3] = { root_dir[0], ':' };
1589
1590 if (WNetGetConnection (drive, remote_name, sizeof (remote_name))
1591 == NO_ERROR)
1592 /* do something */ ;
1593 }
1594 #endif
1595
1596 info = lookup_volume_info (root_dir);
1597
1598 if (info == NULL || ! VOLINFO_STILL_VALID (root_dir, info))
1599 {
1600 char name[ 256 ];
1601 DWORD serialnum;
1602 DWORD maxcomp;
1603 DWORD flags;
1604 char type[ 256 ];
1605
1606 /* Info is not cached, or is stale. */
1607 if (!GetVolumeInformation (root_dir,
1608 name, sizeof (name),
1609 &serialnum,
1610 &maxcomp,
1611 &flags,
1612 type, sizeof (type)))
1613 return NULL;
1614
1615 /* Cache the volume information for future use, overwriting existing
1616 entry if present. */
1617 if (info == NULL)
1618 {
1619 info = (volume_info_data *) xmalloc (sizeof (volume_info_data));
1620 add_volume_info (root_dir, info);
1621 }
1622 else
1623 {
1624 xfree (info->name);
1625 xfree (info->type);
1626 }
1627
1628 info->name = xstrdup (name);
1629 info->serialnum = serialnum;
1630 info->maxcomp = maxcomp;
1631 info->flags = flags;
1632 info->type = xstrdup (type);
1633 info->timestamp = GetTickCount ();
1634 }
1635
1636 return info;
1637 }
1638
1639 /* Get information on the volume where name is held; set path pointer to
1640 start of pathname in name (past UNC header\volume header if present). */
1641 int
1642 get_volume_info (const char * name, const char ** pPath)
1643 {
1644 char temp[MAX_PATH];
1645 char *rootname = NULL; /* default to current volume */
1646 volume_info_data * info;
1647
1648 if (name == NULL)
1649 return FALSE;
1650
1651 /* find the root name of the volume if given */
1652 if (isalpha (name[0]) && name[1] == ':')
1653 {
1654 rootname = temp;
1655 temp[0] = *name++;
1656 temp[1] = *name++;
1657 temp[2] = '\\';
1658 temp[3] = 0;
1659 }
1660 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
1661 {
1662 char *str = temp;
1663 int slashes = 4;
1664 rootname = temp;
1665 do
1666 {
1667 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
1668 break;
1669 *str++ = *name++;
1670 }
1671 while ( *name );
1672
1673 *str++ = '\\';
1674 *str = 0;
1675 }
1676
1677 if (pPath)
1678 *pPath = name;
1679
1680 info = GetCachedVolumeInformation (rootname);
1681 if (info != NULL)
1682 {
1683 /* Set global referenced by other functions. */
1684 volume_info = *info;
1685 return TRUE;
1686 }
1687 return FALSE;
1688 }
1689
1690 /* Determine if volume is FAT format (ie. only supports short 8.3
1691 names); also set path pointer to start of pathname in name. */
1692 int
1693 is_fat_volume (const char * name, const char ** pPath)
1694 {
1695 if (get_volume_info (name, pPath))
1696 return (volume_info.maxcomp == 12);
1697 return FALSE;
1698 }
1699
1700 /* Map filename to a valid 8.3 name if necessary. */
1701 const char *
1702 map_w32_filename (const char * name, const char ** pPath)
1703 {
1704 static char shortname[MAX_PATH];
1705 char * str = shortname;
1706 char c;
1707 char * path;
1708 const char * save_name = name;
1709
1710 if (strlen (name) >= MAX_PATH)
1711 {
1712 /* Return a filename which will cause callers to fail. */
1713 strcpy (shortname, "?");
1714 return shortname;
1715 }
1716
1717 if (is_fat_volume (name, (const char **)&path)) /* truncate to 8.3 */
1718 {
1719 register int left = 8; /* maximum number of chars in part */
1720 register int extn = 0; /* extension added? */
1721 register int dots = 2; /* maximum number of dots allowed */
1722
1723 while (name < path)
1724 *str++ = *name++; /* skip past UNC header */
1725
1726 while ((c = *name++))
1727 {
1728 switch ( c )
1729 {
1730 case '\\':
1731 case '/':
1732 *str++ = '\\';
1733 extn = 0; /* reset extension flags */
1734 dots = 2; /* max 2 dots */
1735 left = 8; /* max length 8 for main part */
1736 break;
1737 case ':':
1738 *str++ = ':';
1739 extn = 0; /* reset extension flags */
1740 dots = 2; /* max 2 dots */
1741 left = 8; /* max length 8 for main part */
1742 break;
1743 case '.':
1744 if ( dots )
1745 {
1746 /* Convert path components of the form .xxx to _xxx,
1747 but leave . and .. as they are. This allows .emacs
1748 to be read as _emacs, for example. */
1749
1750 if (! *name ||
1751 *name == '.' ||
1752 IS_DIRECTORY_SEP (*name))
1753 {
1754 *str++ = '.';
1755 dots--;
1756 }
1757 else
1758 {
1759 *str++ = '_';
1760 left--;
1761 dots = 0;
1762 }
1763 }
1764 else if ( !extn )
1765 {
1766 *str++ = '.';
1767 extn = 1; /* we've got an extension */
1768 left = 3; /* 3 chars in extension */
1769 }
1770 else
1771 {
1772 /* any embedded dots after the first are converted to _ */
1773 *str++ = '_';
1774 }
1775 break;
1776 case '~':
1777 case '#': /* don't lose these, they're important */
1778 if ( ! left )
1779 str[-1] = c; /* replace last character of part */
1780 /* FALLTHRU */
1781 default:
1782 if ( left )
1783 {
1784 *str++ = tolower (c); /* map to lower case (looks nicer) */
1785 left--;
1786 dots = 0; /* started a path component */
1787 }
1788 break;
1789 }
1790 }
1791 *str = '\0';
1792 }
1793 else
1794 {
1795 strcpy (shortname, name);
1796 unixtodos_filename (shortname);
1797 }
1798
1799 if (pPath)
1800 *pPath = shortname + (path - save_name);
1801
1802 return shortname;
1803 }
1804
1805 static int
1806 is_exec (const char * name)
1807 {
1808 char * p = strrchr (name, '.');
1809 return
1810 (p != NULL
1811 && (stricmp (p, ".exe") == 0 ||
1812 stricmp (p, ".com") == 0 ||
1813 stricmp (p, ".bat") == 0 ||
1814 stricmp (p, ".cmd") == 0));
1815 }
1816
1817 /* Emulate the Unix directory procedures opendir, closedir,
1818 and readdir. We can't use the procedures supplied in sysdep.c,
1819 so we provide them here. */
1820
1821 struct direct dir_static; /* simulated directory contents */
1822 static HANDLE dir_find_handle = INVALID_HANDLE_VALUE;
1823 static int dir_is_fat;
1824 static char dir_pathname[MAXPATHLEN+1];
1825 static WIN32_FIND_DATA dir_find_data;
1826
1827 /* Support shares on a network resource as subdirectories of a read-only
1828 root directory. */
1829 static HANDLE wnet_enum_handle = INVALID_HANDLE_VALUE;
1830 HANDLE open_unc_volume (const char *);
1831 char *read_unc_volume (HANDLE, char *, int);
1832 void close_unc_volume (HANDLE);
1833
1834 DIR *
1835 opendir (char *filename)
1836 {
1837 DIR *dirp;
1838
1839 /* Opening is done by FindFirstFile. However, a read is inherent to
1840 this operation, so we defer the open until read time. */
1841
1842 if (dir_find_handle != INVALID_HANDLE_VALUE)
1843 return NULL;
1844 if (wnet_enum_handle != INVALID_HANDLE_VALUE)
1845 return NULL;
1846
1847 if (is_unc_volume (filename))
1848 {
1849 wnet_enum_handle = open_unc_volume (filename);
1850 if (wnet_enum_handle == INVALID_HANDLE_VALUE)
1851 return NULL;
1852 }
1853
1854 if (!(dirp = (DIR *) malloc (sizeof (DIR))))
1855 return NULL;
1856
1857 dirp->dd_fd = 0;
1858 dirp->dd_loc = 0;
1859 dirp->dd_size = 0;
1860
1861 strncpy (dir_pathname, map_w32_filename (filename, NULL), MAXPATHLEN);
1862 dir_pathname[MAXPATHLEN] = '\0';
1863 dir_is_fat = is_fat_volume (filename, NULL);
1864
1865 return dirp;
1866 }
1867
1868 void
1869 closedir (DIR *dirp)
1870 {
1871 /* If we have a find-handle open, close it. */
1872 if (dir_find_handle != INVALID_HANDLE_VALUE)
1873 {
1874 FindClose (dir_find_handle);
1875 dir_find_handle = INVALID_HANDLE_VALUE;
1876 }
1877 else if (wnet_enum_handle != INVALID_HANDLE_VALUE)
1878 {
1879 close_unc_volume (wnet_enum_handle);
1880 wnet_enum_handle = INVALID_HANDLE_VALUE;
1881 }
1882 xfree ((char *) dirp);
1883 }
1884
1885 struct direct *
1886 readdir (DIR *dirp)
1887 {
1888 int downcase = !NILP (Vw32_downcase_file_names);
1889
1890 if (wnet_enum_handle != INVALID_HANDLE_VALUE)
1891 {
1892 if (!read_unc_volume (wnet_enum_handle,
1893 dir_find_data.cFileName,
1894 MAX_PATH))
1895 return NULL;
1896 }
1897 /* If we aren't dir_finding, do a find-first, otherwise do a find-next. */
1898 else if (dir_find_handle == INVALID_HANDLE_VALUE)
1899 {
1900 char filename[MAXNAMLEN + 3];
1901 int ln;
1902
1903 strcpy (filename, dir_pathname);
1904 ln = strlen (filename) - 1;
1905 if (!IS_DIRECTORY_SEP (filename[ln]))
1906 strcat (filename, "\\");
1907 strcat (filename, "*");
1908
1909 dir_find_handle = FindFirstFile (filename, &dir_find_data);
1910
1911 if (dir_find_handle == INVALID_HANDLE_VALUE)
1912 return NULL;
1913 }
1914 else
1915 {
1916 if (!FindNextFile (dir_find_handle, &dir_find_data))
1917 return NULL;
1918 }
1919
1920 /* Emacs never uses this value, so don't bother making it match
1921 value returned by stat(). */
1922 dir_static.d_ino = 1;
1923
1924 strcpy (dir_static.d_name, dir_find_data.cFileName);
1925
1926 /* If the file name in cFileName[] includes `?' characters, it means
1927 the original file name used characters that cannot be represented
1928 by the current ANSI codepage. To avoid total lossage, retrieve
1929 the short 8+3 alias of the long file name. */
1930 if (_mbspbrk (dir_static.d_name, "?"))
1931 {
1932 strcpy (dir_static.d_name, dir_find_data.cAlternateFileName);
1933 downcase = 1; /* 8+3 aliases are returned in all caps */
1934 }
1935 dir_static.d_namlen = strlen (dir_static.d_name);
1936 dir_static.d_reclen = sizeof (struct direct) - MAXNAMLEN + 3 +
1937 dir_static.d_namlen - dir_static.d_namlen % 4;
1938 if (dir_is_fat)
1939 _strlwr (dir_static.d_name);
1940 else if (downcase)
1941 {
1942 register char *p;
1943 for (p = dir_static.d_name; *p; p++)
1944 if (*p >= 'a' && *p <= 'z')
1945 break;
1946 if (!*p)
1947 _strlwr (dir_static.d_name);
1948 }
1949
1950 return &dir_static;
1951 }
1952
1953 HANDLE
1954 open_unc_volume (const char *path)
1955 {
1956 NETRESOURCE nr;
1957 HANDLE henum;
1958 int result;
1959
1960 nr.dwScope = RESOURCE_GLOBALNET;
1961 nr.dwType = RESOURCETYPE_DISK;
1962 nr.dwDisplayType = RESOURCEDISPLAYTYPE_SERVER;
1963 nr.dwUsage = RESOURCEUSAGE_CONTAINER;
1964 nr.lpLocalName = NULL;
1965 nr.lpRemoteName = (LPSTR)map_w32_filename (path, NULL);
1966 nr.lpComment = NULL;
1967 nr.lpProvider = NULL;
1968
1969 result = WNetOpenEnum(RESOURCE_GLOBALNET, RESOURCETYPE_DISK,
1970 RESOURCEUSAGE_CONNECTABLE, &nr, &henum);
1971
1972 if (result == NO_ERROR)
1973 return henum;
1974 else
1975 return INVALID_HANDLE_VALUE;
1976 }
1977
1978 char *
1979 read_unc_volume (HANDLE henum, char *readbuf, int size)
1980 {
1981 DWORD count;
1982 int result;
1983 DWORD bufsize = 512;
1984 char *buffer;
1985 char *ptr;
1986
1987 count = 1;
1988 buffer = alloca (bufsize);
1989 result = WNetEnumResource (wnet_enum_handle, &count, buffer, &bufsize);
1990 if (result != NO_ERROR)
1991 return NULL;
1992
1993 /* WNetEnumResource returns \\resource\share...skip forward to "share". */
1994 ptr = ((LPNETRESOURCE) buffer)->lpRemoteName;
1995 ptr += 2;
1996 while (*ptr && !IS_DIRECTORY_SEP (*ptr)) ptr++;
1997 ptr++;
1998
1999 strncpy (readbuf, ptr, size);
2000 return readbuf;
2001 }
2002
2003 void
2004 close_unc_volume (HANDLE henum)
2005 {
2006 if (henum != INVALID_HANDLE_VALUE)
2007 WNetCloseEnum (henum);
2008 }
2009
2010 DWORD
2011 unc_volume_file_attributes (const char *path)
2012 {
2013 HANDLE henum;
2014 DWORD attrs;
2015
2016 henum = open_unc_volume (path);
2017 if (henum == INVALID_HANDLE_VALUE)
2018 return -1;
2019
2020 attrs = FILE_ATTRIBUTE_READONLY | FILE_ATTRIBUTE_DIRECTORY;
2021
2022 close_unc_volume (henum);
2023
2024 return attrs;
2025 }
2026
2027 /* Ensure a network connection is authenticated. */
2028 static void
2029 logon_network_drive (const char *path)
2030 {
2031 NETRESOURCE resource;
2032 char share[MAX_PATH];
2033 int i, n_slashes;
2034
2035 /* Only logon to networked drives. */
2036 if (!IS_DIRECTORY_SEP (path[0]) || !IS_DIRECTORY_SEP (path[1]))
2037 return;
2038 n_slashes = 2;
2039 strncpy (share, path, MAX_PATH);
2040 /* Truncate to just server and share name. */
2041 for (i = 2; i < MAX_PATH; i++)
2042 {
2043 if (IS_DIRECTORY_SEP (share[i]) && ++n_slashes > 3)
2044 {
2045 share[i] = '\0';
2046 break;
2047 }
2048 }
2049
2050 resource.dwType = RESOURCETYPE_DISK;
2051 resource.lpLocalName = NULL;
2052 resource.lpRemoteName = share;
2053 resource.lpProvider = NULL;
2054
2055 WNetAddConnection2 (&resource, NULL, NULL, CONNECT_INTERACTIVE);
2056 }
2057
2058 /* Shadow some MSVC runtime functions to map requests for long filenames
2059 to reasonable short names if necessary. This was originally added to
2060 permit running Emacs on NT 3.1 on a FAT partition, which doesn't support
2061 long file names. */
2062
2063 int
2064 sys_access (const char * path, int mode)
2065 {
2066 DWORD attributes;
2067
2068 /* MSVC implementation doesn't recognize D_OK. */
2069 path = map_w32_filename (path, NULL);
2070 if (is_unc_volume (path))
2071 {
2072 attributes = unc_volume_file_attributes (path);
2073 if (attributes == -1) {
2074 errno = EACCES;
2075 return -1;
2076 }
2077 }
2078 else if ((attributes = GetFileAttributes (path)) == -1)
2079 {
2080 /* Should try mapping GetLastError to errno; for now just indicate
2081 that path doesn't exist. */
2082 errno = EACCES;
2083 return -1;
2084 }
2085 if ((mode & X_OK) != 0 && !is_exec (path))
2086 {
2087 errno = EACCES;
2088 return -1;
2089 }
2090 if ((mode & W_OK) != 0 && (attributes & FILE_ATTRIBUTE_READONLY) != 0)
2091 {
2092 errno = EACCES;
2093 return -1;
2094 }
2095 if ((mode & D_OK) != 0 && (attributes & FILE_ATTRIBUTE_DIRECTORY) == 0)
2096 {
2097 errno = EACCES;
2098 return -1;
2099 }
2100 return 0;
2101 }
2102
2103 int
2104 sys_chdir (const char * path)
2105 {
2106 return _chdir (map_w32_filename (path, NULL));
2107 }
2108
2109 int
2110 sys_chmod (const char * path, int mode)
2111 {
2112 return _chmod (map_w32_filename (path, NULL), mode);
2113 }
2114
2115 int
2116 sys_chown (const char *path, uid_t owner, gid_t group)
2117 {
2118 if (sys_chmod (path, S_IREAD) == -1) /* check if file exists */
2119 return -1;
2120 return 0;
2121 }
2122
2123 int
2124 sys_creat (const char * path, int mode)
2125 {
2126 return _creat (map_w32_filename (path, NULL), mode);
2127 }
2128
2129 FILE *
2130 sys_fopen(const char * path, const char * mode)
2131 {
2132 int fd;
2133 int oflag;
2134 const char * mode_save = mode;
2135
2136 /* Force all file handles to be non-inheritable. This is necessary to
2137 ensure child processes don't unwittingly inherit handles that might
2138 prevent future file access. */
2139
2140 if (mode[0] == 'r')
2141 oflag = O_RDONLY;
2142 else if (mode[0] == 'w' || mode[0] == 'a')
2143 oflag = O_WRONLY | O_CREAT | O_TRUNC;
2144 else
2145 return NULL;
2146
2147 /* Only do simplistic option parsing. */
2148 while (*++mode)
2149 if (mode[0] == '+')
2150 {
2151 oflag &= ~(O_RDONLY | O_WRONLY);
2152 oflag |= O_RDWR;
2153 }
2154 else if (mode[0] == 'b')
2155 {
2156 oflag &= ~O_TEXT;
2157 oflag |= O_BINARY;
2158 }
2159 else if (mode[0] == 't')
2160 {
2161 oflag &= ~O_BINARY;
2162 oflag |= O_TEXT;
2163 }
2164 else break;
2165
2166 fd = _open (map_w32_filename (path, NULL), oflag | _O_NOINHERIT, 0644);
2167 if (fd < 0)
2168 return NULL;
2169
2170 return _fdopen (fd, mode_save);
2171 }
2172
2173 /* This only works on NTFS volumes, but is useful to have. */
2174 int
2175 sys_link (const char * old, const char * new)
2176 {
2177 HANDLE fileh;
2178 int result = -1;
2179 char oldname[MAX_PATH], newname[MAX_PATH];
2180
2181 if (old == NULL || new == NULL)
2182 {
2183 errno = ENOENT;
2184 return -1;
2185 }
2186
2187 strcpy (oldname, map_w32_filename (old, NULL));
2188 strcpy (newname, map_w32_filename (new, NULL));
2189
2190 fileh = CreateFile (oldname, 0, 0, NULL, OPEN_EXISTING,
2191 FILE_FLAG_BACKUP_SEMANTICS, NULL);
2192 if (fileh != INVALID_HANDLE_VALUE)
2193 {
2194 int wlen;
2195
2196 /* Confusingly, the "alternate" stream name field does not apply
2197 when restoring a hard link, and instead contains the actual
2198 stream data for the link (ie. the name of the link to create).
2199 The WIN32_STREAM_ID structure before the cStreamName field is
2200 the stream header, which is then immediately followed by the
2201 stream data. */
2202
2203 struct {
2204 WIN32_STREAM_ID wid;
2205 WCHAR wbuffer[MAX_PATH]; /* extra space for link name */
2206 } data;
2207
2208 wlen = MultiByteToWideChar (CP_ACP, MB_PRECOMPOSED, newname, -1,
2209 data.wid.cStreamName, MAX_PATH);
2210 if (wlen > 0)
2211 {
2212 LPVOID context = NULL;
2213 DWORD wbytes = 0;
2214
2215 data.wid.dwStreamId = BACKUP_LINK;
2216 data.wid.dwStreamAttributes = 0;
2217 data.wid.Size.LowPart = wlen * sizeof(WCHAR);
2218 data.wid.Size.HighPart = 0;
2219 data.wid.dwStreamNameSize = 0;
2220
2221 if (BackupWrite (fileh, (LPBYTE)&data,
2222 offsetof (WIN32_STREAM_ID, cStreamName)
2223 + data.wid.Size.LowPart,
2224 &wbytes, FALSE, FALSE, &context)
2225 && BackupWrite (fileh, NULL, 0, &wbytes, TRUE, FALSE, &context))
2226 {
2227 /* succeeded */
2228 result = 0;
2229 }
2230 else
2231 {
2232 /* Should try mapping GetLastError to errno; for now just
2233 indicate a general error (eg. links not supported). */
2234 errno = EINVAL; // perhaps EMLINK?
2235 }
2236 }
2237
2238 CloseHandle (fileh);
2239 }
2240 else
2241 errno = ENOENT;
2242
2243 return result;
2244 }
2245
2246 int
2247 sys_mkdir (const char * path)
2248 {
2249 return _mkdir (map_w32_filename (path, NULL));
2250 }
2251
2252 /* Because of long name mapping issues, we need to implement this
2253 ourselves. Also, MSVC's _mktemp returns NULL when it can't generate
2254 a unique name, instead of setting the input template to an empty
2255 string.
2256
2257 Standard algorithm seems to be use pid or tid with a letter on the
2258 front (in place of the 6 X's) and cycle through the letters to find a
2259 unique name. We extend that to allow any reasonable character as the
2260 first of the 6 X's. */
2261 char *
2262 sys_mktemp (char * template)
2263 {
2264 char * p;
2265 int i;
2266 unsigned uid = GetCurrentThreadId ();
2267 static char first_char[] = "abcdefghijklmnopqrstuvwyz0123456789!%-_@#";
2268
2269 if (template == NULL)
2270 return NULL;
2271 p = template + strlen (template);
2272 i = 5;
2273 /* replace up to the last 5 X's with uid in decimal */
2274 while (--p >= template && p[0] == 'X' && --i >= 0)
2275 {
2276 p[0] = '0' + uid % 10;
2277 uid /= 10;
2278 }
2279
2280 if (i < 0 && p[0] == 'X')
2281 {
2282 i = 0;
2283 do
2284 {
2285 int save_errno = errno;
2286 p[0] = first_char[i];
2287 if (sys_access (template, 0) < 0)
2288 {
2289 errno = save_errno;
2290 return template;
2291 }
2292 }
2293 while (++i < sizeof (first_char));
2294 }
2295
2296 /* Template is badly formed or else we can't generate a unique name,
2297 so return empty string */
2298 template[0] = 0;
2299 return template;
2300 }
2301
2302 int
2303 sys_open (const char * path, int oflag, int mode)
2304 {
2305 const char* mpath = map_w32_filename (path, NULL);
2306 /* Try to open file without _O_CREAT, to be able to write to hidden
2307 and system files. Force all file handles to be
2308 non-inheritable. */
2309 int res = _open (mpath, (oflag & ~_O_CREAT) | _O_NOINHERIT, mode);
2310 if (res >= 0)
2311 return res;
2312 return _open (mpath, oflag | _O_NOINHERIT, mode);
2313 }
2314
2315 int
2316 sys_rename (const char * oldname, const char * newname)
2317 {
2318 BOOL result;
2319 char temp[MAX_PATH];
2320
2321 /* MoveFile on Windows 95 doesn't correctly change the short file name
2322 alias in a number of circumstances (it is not easy to predict when
2323 just by looking at oldname and newname, unfortunately). In these
2324 cases, renaming through a temporary name avoids the problem.
2325
2326 A second problem on Windows 95 is that renaming through a temp name when
2327 newname is uppercase fails (the final long name ends up in
2328 lowercase, although the short alias might be uppercase) UNLESS the
2329 long temp name is not 8.3.
2330
2331 So, on Windows 95 we always rename through a temp name, and we make sure
2332 the temp name has a long extension to ensure correct renaming. */
2333
2334 strcpy (temp, map_w32_filename (oldname, NULL));
2335
2336 if (os_subtype == OS_WIN95)
2337 {
2338 char * o;
2339 char * p;
2340 int i = 0;
2341
2342 oldname = map_w32_filename (oldname, NULL);
2343 if (o = strrchr (oldname, '\\'))
2344 o++;
2345 else
2346 o = (char *) oldname;
2347
2348 if (p = strrchr (temp, '\\'))
2349 p++;
2350 else
2351 p = temp;
2352
2353 do
2354 {
2355 /* Force temp name to require a manufactured 8.3 alias - this
2356 seems to make the second rename work properly. */
2357 sprintf (p, "_.%s.%u", o, i);
2358 i++;
2359 result = rename (oldname, temp);
2360 }
2361 /* This loop must surely terminate! */
2362 while (result < 0 && errno == EEXIST);
2363 if (result < 0)
2364 return -1;
2365 }
2366
2367 /* Emulate Unix behaviour - newname is deleted if it already exists
2368 (at least if it is a file; don't do this for directories).
2369
2370 Since we mustn't do this if we are just changing the case of the
2371 file name (we would end up deleting the file we are trying to
2372 rename!), we let rename detect if the destination file already
2373 exists - that way we avoid the possible pitfalls of trying to
2374 determine ourselves whether two names really refer to the same
2375 file, which is not always possible in the general case. (Consider
2376 all the permutations of shared or subst'd drives, etc.) */
2377
2378 newname = map_w32_filename (newname, NULL);
2379 result = rename (temp, newname);
2380
2381 if (result < 0
2382 && errno == EEXIST
2383 && _chmod (newname, 0666) == 0
2384 && _unlink (newname) == 0)
2385 result = rename (temp, newname);
2386
2387 return result;
2388 }
2389
2390 int
2391 sys_rmdir (const char * path)
2392 {
2393 return _rmdir (map_w32_filename (path, NULL));
2394 }
2395
2396 int
2397 sys_unlink (const char * path)
2398 {
2399 path = map_w32_filename (path, NULL);
2400
2401 /* On Unix, unlink works without write permission. */
2402 _chmod (path, 0666);
2403 return _unlink (path);
2404 }
2405
2406 static FILETIME utc_base_ft;
2407 static long double utc_base;
2408 static int init = 0;
2409
2410 static time_t
2411 convert_time (FILETIME ft)
2412 {
2413 long double ret;
2414
2415 if (!init)
2416 {
2417 /* Determine the delta between 1-Jan-1601 and 1-Jan-1970. */
2418 SYSTEMTIME st;
2419
2420 st.wYear = 1970;
2421 st.wMonth = 1;
2422 st.wDay = 1;
2423 st.wHour = 0;
2424 st.wMinute = 0;
2425 st.wSecond = 0;
2426 st.wMilliseconds = 0;
2427
2428 SystemTimeToFileTime (&st, &utc_base_ft);
2429 utc_base = (long double) utc_base_ft.dwHighDateTime
2430 * 4096.0L * 1024.0L * 1024.0L + utc_base_ft.dwLowDateTime;
2431 init = 1;
2432 }
2433
2434 if (CompareFileTime (&ft, &utc_base_ft) < 0)
2435 return 0;
2436
2437 ret = (long double) ft.dwHighDateTime
2438 * 4096.0L * 1024.0L * 1024.0L + ft.dwLowDateTime;
2439 ret -= utc_base;
2440 return (time_t) (ret * 1e-7L);
2441 }
2442
2443 void
2444 convert_from_time_t (time_t time, FILETIME * pft)
2445 {
2446 long double tmp;
2447
2448 if (!init)
2449 {
2450 /* Determine the delta between 1-Jan-1601 and 1-Jan-1970. */
2451 SYSTEMTIME st;
2452
2453 st.wYear = 1970;
2454 st.wMonth = 1;
2455 st.wDay = 1;
2456 st.wHour = 0;
2457 st.wMinute = 0;
2458 st.wSecond = 0;
2459 st.wMilliseconds = 0;
2460
2461 SystemTimeToFileTime (&st, &utc_base_ft);
2462 utc_base = (long double) utc_base_ft.dwHighDateTime
2463 * 4096 * 1024 * 1024 + utc_base_ft.dwLowDateTime;
2464 init = 1;
2465 }
2466
2467 /* time in 100ns units since 1-Jan-1601 */
2468 tmp = (long double) time * 1e7 + utc_base;
2469 pft->dwHighDateTime = (DWORD) (tmp / (4096.0 * 1024 * 1024));
2470 pft->dwLowDateTime = (DWORD) (tmp - (4096.0 * 1024 * 1024) * pft->dwHighDateTime);
2471 }
2472
2473 #if 0
2474 /* No reason to keep this; faking inode values either by hashing or even
2475 using the file index from GetInformationByHandle, is not perfect and
2476 so by default Emacs doesn't use the inode values on Windows.
2477 Instead, we now determine file-truename correctly (except for
2478 possible drive aliasing etc). */
2479
2480 /* Modified version of "PJW" algorithm (see the "Dragon" compiler book). */
2481 static unsigned
2482 hashval (const unsigned char * str)
2483 {
2484 unsigned h = 0;
2485 while (*str)
2486 {
2487 h = (h << 4) + *str++;
2488 h ^= (h >> 28);
2489 }
2490 return h;
2491 }
2492
2493 /* Return the hash value of the canonical pathname, excluding the
2494 drive/UNC header, to get a hopefully unique inode number. */
2495 static DWORD
2496 generate_inode_val (const char * name)
2497 {
2498 char fullname[ MAX_PATH ];
2499 char * p;
2500 unsigned hash;
2501
2502 /* Get the truly canonical filename, if it exists. (Note: this
2503 doesn't resolve aliasing due to subst commands, or recognise hard
2504 links. */
2505 if (!w32_get_long_filename ((char *)name, fullname, MAX_PATH))
2506 abort ();
2507
2508 parse_root (fullname, &p);
2509 /* Normal W32 filesystems are still case insensitive. */
2510 _strlwr (p);
2511 return hashval (p);
2512 }
2513
2514 #endif
2515
2516 /* MSVC stat function can't cope with UNC names and has other bugs, so
2517 replace it with our own. This also allows us to calculate consistent
2518 inode values without hacks in the main Emacs code. */
2519 int
2520 stat (const char * path, struct stat * buf)
2521 {
2522 char *name, *r;
2523 WIN32_FIND_DATA wfd;
2524 HANDLE fh;
2525 unsigned __int64 fake_inode;
2526 int permission;
2527 int len;
2528 int rootdir = FALSE;
2529
2530 if (path == NULL || buf == NULL)
2531 {
2532 errno = EFAULT;
2533 return -1;
2534 }
2535
2536 name = (char *) map_w32_filename (path, &path);
2537 /* Must be valid filename, no wild cards or other invalid
2538 characters. We use _mbspbrk to support multibyte strings that
2539 might look to strpbrk as if they included literal *, ?, and other
2540 characters mentioned below that are disallowed by Windows
2541 filesystems. */
2542 if (_mbspbrk (name, "*?|<>\""))
2543 {
2544 errno = ENOENT;
2545 return -1;
2546 }
2547
2548 /* If name is "c:/.." or "/.." then stat "c:/" or "/". */
2549 r = IS_DEVICE_SEP (name[1]) ? &name[2] : name;
2550 if (IS_DIRECTORY_SEP (r[0]) && r[1] == '.' && r[2] == '.' && r[3] == '\0')
2551 {
2552 r[1] = r[2] = '\0';
2553 }
2554
2555 /* Remove trailing directory separator, unless name is the root
2556 directory of a drive or UNC volume in which case ensure there
2557 is a trailing separator. */
2558 len = strlen (name);
2559 rootdir = (path >= name + len - 1
2560 && (IS_DIRECTORY_SEP (*path) || *path == 0));
2561 name = strcpy (alloca (len + 2), name);
2562
2563 if (is_unc_volume (name))
2564 {
2565 DWORD attrs = unc_volume_file_attributes (name);
2566
2567 if (attrs == -1)
2568 return -1;
2569
2570 memset (&wfd, 0, sizeof (wfd));
2571 wfd.dwFileAttributes = attrs;
2572 wfd.ftCreationTime = utc_base_ft;
2573 wfd.ftLastAccessTime = utc_base_ft;
2574 wfd.ftLastWriteTime = utc_base_ft;
2575 strcpy (wfd.cFileName, name);
2576 }
2577 else if (rootdir)
2578 {
2579 if (!IS_DIRECTORY_SEP (name[len-1]))
2580 strcat (name, "\\");
2581 if (GetDriveType (name) < 2)
2582 {
2583 errno = ENOENT;
2584 return -1;
2585 }
2586 memset (&wfd, 0, sizeof (wfd));
2587 wfd.dwFileAttributes = FILE_ATTRIBUTE_DIRECTORY;
2588 wfd.ftCreationTime = utc_base_ft;
2589 wfd.ftLastAccessTime = utc_base_ft;
2590 wfd.ftLastWriteTime = utc_base_ft;
2591 strcpy (wfd.cFileName, name);
2592 }
2593 else
2594 {
2595 if (IS_DIRECTORY_SEP (name[len-1]))
2596 name[len - 1] = 0;
2597
2598 /* (This is hacky, but helps when doing file completions on
2599 network drives.) Optimize by using information available from
2600 active readdir if possible. */
2601 len = strlen (dir_pathname);
2602 if (IS_DIRECTORY_SEP (dir_pathname[len-1]))
2603 len--;
2604 if (dir_find_handle != INVALID_HANDLE_VALUE
2605 && strnicmp (name, dir_pathname, len) == 0
2606 && IS_DIRECTORY_SEP (name[len])
2607 && stricmp (name + len + 1, dir_static.d_name) == 0)
2608 {
2609 /* This was the last entry returned by readdir. */
2610 wfd = dir_find_data;
2611 }
2612 else
2613 {
2614 logon_network_drive (name);
2615
2616 fh = FindFirstFile (name, &wfd);
2617 if (fh == INVALID_HANDLE_VALUE)
2618 {
2619 errno = ENOENT;
2620 return -1;
2621 }
2622 FindClose (fh);
2623 }
2624 }
2625
2626 if (!NILP (Vw32_get_true_file_attributes)
2627 /* No access rights required to get info. */
2628 && (fh = CreateFile (name, 0, 0, NULL, OPEN_EXISTING,
2629 FILE_FLAG_BACKUP_SEMANTICS, NULL))
2630 != INVALID_HANDLE_VALUE)
2631 {
2632 /* This is more accurate in terms of gettting the correct number
2633 of links, but is quite slow (it is noticeable when Emacs is
2634 making a list of file name completions). */
2635 BY_HANDLE_FILE_INFORMATION info;
2636
2637 if (GetFileInformationByHandle (fh, &info))
2638 {
2639 buf->st_nlink = info.nNumberOfLinks;
2640 /* Might as well use file index to fake inode values, but this
2641 is not guaranteed to be unique unless we keep a handle open
2642 all the time (even then there are situations where it is
2643 not unique). Reputedly, there are at most 48 bits of info
2644 (on NTFS, presumably less on FAT). */
2645 fake_inode = info.nFileIndexHigh;
2646 fake_inode <<= 32;
2647 fake_inode += info.nFileIndexLow;
2648 }
2649 else
2650 {
2651 buf->st_nlink = 1;
2652 fake_inode = 0;
2653 }
2654
2655 if (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2656 {
2657 buf->st_mode = S_IFDIR;
2658 }
2659 else
2660 {
2661 switch (GetFileType (fh))
2662 {
2663 case FILE_TYPE_DISK:
2664 buf->st_mode = S_IFREG;
2665 break;
2666 case FILE_TYPE_PIPE:
2667 buf->st_mode = S_IFIFO;
2668 break;
2669 case FILE_TYPE_CHAR:
2670 case FILE_TYPE_UNKNOWN:
2671 default:
2672 buf->st_mode = S_IFCHR;
2673 }
2674 }
2675 CloseHandle (fh);
2676 }
2677 else
2678 {
2679 /* Don't bother to make this information more accurate. */
2680 buf->st_mode = (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) ?
2681 S_IFDIR : S_IFREG;
2682 buf->st_nlink = 1;
2683 fake_inode = 0;
2684 }
2685
2686 #if 0
2687 /* Not sure if there is any point in this. */
2688 if (!NILP (Vw32_generate_fake_inodes))
2689 fake_inode = generate_inode_val (name);
2690 else if (fake_inode == 0)
2691 {
2692 /* For want of something better, try to make everything unique. */
2693 static DWORD gen_num = 0;
2694 fake_inode = ++gen_num;
2695 }
2696 #endif
2697
2698 /* MSVC defines _ino_t to be short; other libc's might not. */
2699 if (sizeof (buf->st_ino) == 2)
2700 buf->st_ino = fake_inode ^ (fake_inode >> 16);
2701 else
2702 buf->st_ino = fake_inode;
2703
2704 /* consider files to belong to current user */
2705 buf->st_uid = the_passwd.pw_uid;
2706 buf->st_gid = the_passwd.pw_gid;
2707
2708 /* volume_info is set indirectly by map_w32_filename */
2709 buf->st_dev = volume_info.serialnum;
2710 buf->st_rdev = volume_info.serialnum;
2711
2712
2713 buf->st_size = wfd.nFileSizeLow;
2714
2715 /* Convert timestamps to Unix format. */
2716 buf->st_mtime = convert_time (wfd.ftLastWriteTime);
2717 buf->st_atime = convert_time (wfd.ftLastAccessTime);
2718 if (buf->st_atime == 0) buf->st_atime = buf->st_mtime;
2719 buf->st_ctime = convert_time (wfd.ftCreationTime);
2720 if (buf->st_ctime == 0) buf->st_ctime = buf->st_mtime;
2721
2722 /* determine rwx permissions */
2723 if (wfd.dwFileAttributes & FILE_ATTRIBUTE_READONLY)
2724 permission = S_IREAD;
2725 else
2726 permission = S_IREAD | S_IWRITE;
2727
2728 if (wfd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2729 permission |= S_IEXEC;
2730 else if (is_exec (name))
2731 permission |= S_IEXEC;
2732
2733 buf->st_mode |= permission | (permission >> 3) | (permission >> 6);
2734
2735 return 0;
2736 }
2737
2738 /* Provide fstat and utime as well as stat for consistent handling of
2739 file timestamps. */
2740 int
2741 fstat (int desc, struct stat * buf)
2742 {
2743 HANDLE fh = (HANDLE) _get_osfhandle (desc);
2744 BY_HANDLE_FILE_INFORMATION info;
2745 unsigned __int64 fake_inode;
2746 int permission;
2747
2748 switch (GetFileType (fh) & ~FILE_TYPE_REMOTE)
2749 {
2750 case FILE_TYPE_DISK:
2751 buf->st_mode = S_IFREG;
2752 if (!GetFileInformationByHandle (fh, &info))
2753 {
2754 errno = EACCES;
2755 return -1;
2756 }
2757 break;
2758 case FILE_TYPE_PIPE:
2759 buf->st_mode = S_IFIFO;
2760 goto non_disk;
2761 case FILE_TYPE_CHAR:
2762 case FILE_TYPE_UNKNOWN:
2763 default:
2764 buf->st_mode = S_IFCHR;
2765 non_disk:
2766 memset (&info, 0, sizeof (info));
2767 info.dwFileAttributes = 0;
2768 info.ftCreationTime = utc_base_ft;
2769 info.ftLastAccessTime = utc_base_ft;
2770 info.ftLastWriteTime = utc_base_ft;
2771 }
2772
2773 if (info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2774 buf->st_mode = S_IFDIR;
2775
2776 buf->st_nlink = info.nNumberOfLinks;
2777 /* Might as well use file index to fake inode values, but this
2778 is not guaranteed to be unique unless we keep a handle open
2779 all the time (even then there are situations where it is
2780 not unique). Reputedly, there are at most 48 bits of info
2781 (on NTFS, presumably less on FAT). */
2782 fake_inode = info.nFileIndexHigh;
2783 fake_inode <<= 32;
2784 fake_inode += info.nFileIndexLow;
2785
2786 /* MSVC defines _ino_t to be short; other libc's might not. */
2787 if (sizeof (buf->st_ino) == 2)
2788 buf->st_ino = fake_inode ^ (fake_inode >> 16);
2789 else
2790 buf->st_ino = fake_inode;
2791
2792 /* consider files to belong to current user */
2793 buf->st_uid = the_passwd.pw_uid;
2794 buf->st_gid = the_passwd.pw_gid;
2795
2796 buf->st_dev = info.dwVolumeSerialNumber;
2797 buf->st_rdev = info.dwVolumeSerialNumber;
2798
2799 buf->st_size = info.nFileSizeLow;
2800
2801 /* Convert timestamps to Unix format. */
2802 buf->st_mtime = convert_time (info.ftLastWriteTime);
2803 buf->st_atime = convert_time (info.ftLastAccessTime);
2804 if (buf->st_atime == 0) buf->st_atime = buf->st_mtime;
2805 buf->st_ctime = convert_time (info.ftCreationTime);
2806 if (buf->st_ctime == 0) buf->st_ctime = buf->st_mtime;
2807
2808 /* determine rwx permissions */
2809 if (info.dwFileAttributes & FILE_ATTRIBUTE_READONLY)
2810 permission = S_IREAD;
2811 else
2812 permission = S_IREAD | S_IWRITE;
2813
2814 if (info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)
2815 permission |= S_IEXEC;
2816 else
2817 {
2818 #if 0 /* no way of knowing the filename */
2819 char * p = strrchr (name, '.');
2820 if (p != NULL &&
2821 (stricmp (p, ".exe") == 0 ||
2822 stricmp (p, ".com") == 0 ||
2823 stricmp (p, ".bat") == 0 ||
2824 stricmp (p, ".cmd") == 0))
2825 permission |= S_IEXEC;
2826 #endif
2827 }
2828
2829 buf->st_mode |= permission | (permission >> 3) | (permission >> 6);
2830
2831 return 0;
2832 }
2833
2834 int
2835 utime (const char *name, struct utimbuf *times)
2836 {
2837 struct utimbuf deftime;
2838 HANDLE fh;
2839 FILETIME mtime;
2840 FILETIME atime;
2841
2842 if (times == NULL)
2843 {
2844 deftime.modtime = deftime.actime = time (NULL);
2845 times = &deftime;
2846 }
2847
2848 /* Need write access to set times. */
2849 fh = CreateFile (name, GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE,
2850 0, OPEN_EXISTING, 0, NULL);
2851 if (fh)
2852 {
2853 convert_from_time_t (times->actime, &atime);
2854 convert_from_time_t (times->modtime, &mtime);
2855 if (!SetFileTime (fh, NULL, &atime, &mtime))
2856 {
2857 CloseHandle (fh);
2858 errno = EACCES;
2859 return -1;
2860 }
2861 CloseHandle (fh);
2862 }
2863 else
2864 {
2865 errno = EINVAL;
2866 return -1;
2867 }
2868 return 0;
2869 }
2870
2871 #ifdef HAVE_SOCKETS
2872
2873 /* Wrappers for winsock functions to map between our file descriptors
2874 and winsock's handles; also set h_errno for convenience.
2875
2876 To allow Emacs to run on systems which don't have winsock support
2877 installed, we dynamically link to winsock on startup if present, and
2878 otherwise provide the minimum necessary functionality
2879 (eg. gethostname). */
2880
2881 /* function pointers for relevant socket functions */
2882 int (PASCAL *pfn_WSAStartup) (WORD wVersionRequired, LPWSADATA lpWSAData);
2883 void (PASCAL *pfn_WSASetLastError) (int iError);
2884 int (PASCAL *pfn_WSAGetLastError) (void);
2885 int (PASCAL *pfn_WSAEventSelect) (SOCKET s, HANDLE hEventObject, long lNetworkEvents);
2886 HANDLE (PASCAL *pfn_WSACreateEvent) (void);
2887 int (PASCAL *pfn_WSACloseEvent) (HANDLE hEvent);
2888 int (PASCAL *pfn_socket) (int af, int type, int protocol);
2889 int (PASCAL *pfn_bind) (SOCKET s, const struct sockaddr *addr, int namelen);
2890 int (PASCAL *pfn_connect) (SOCKET s, const struct sockaddr *addr, int namelen);
2891 int (PASCAL *pfn_ioctlsocket) (SOCKET s, long cmd, u_long *argp);
2892 int (PASCAL *pfn_recv) (SOCKET s, char * buf, int len, int flags);
2893 int (PASCAL *pfn_send) (SOCKET s, const char * buf, int len, int flags);
2894 int (PASCAL *pfn_closesocket) (SOCKET s);
2895 int (PASCAL *pfn_shutdown) (SOCKET s, int how);
2896 int (PASCAL *pfn_WSACleanup) (void);
2897
2898 u_short (PASCAL *pfn_htons) (u_short hostshort);
2899 u_short (PASCAL *pfn_ntohs) (u_short netshort);
2900 unsigned long (PASCAL *pfn_inet_addr) (const char * cp);
2901 int (PASCAL *pfn_gethostname) (char * name, int namelen);
2902 struct hostent * (PASCAL *pfn_gethostbyname) (const char * name);
2903 struct servent * (PASCAL *pfn_getservbyname) (const char * name, const char * proto);
2904 int (PASCAL *pfn_getpeername) (SOCKET s, struct sockaddr *addr, int * namelen);
2905 int (PASCAL *pfn_setsockopt) (SOCKET s, int level, int optname,
2906 const char * optval, int optlen);
2907 int (PASCAL *pfn_listen) (SOCKET s, int backlog);
2908 int (PASCAL *pfn_getsockname) (SOCKET s, struct sockaddr * name,
2909 int * namelen);
2910 SOCKET (PASCAL *pfn_accept) (SOCKET s, struct sockaddr * addr, int * addrlen);
2911 int (PASCAL *pfn_recvfrom) (SOCKET s, char * buf, int len, int flags,
2912 struct sockaddr * from, int * fromlen);
2913 int (PASCAL *pfn_sendto) (SOCKET s, const char * buf, int len, int flags,
2914 const struct sockaddr * to, int tolen);
2915
2916 /* SetHandleInformation is only needed to make sockets non-inheritable. */
2917 BOOL (WINAPI *pfn_SetHandleInformation) (HANDLE object, DWORD mask, DWORD flags);
2918 #ifndef HANDLE_FLAG_INHERIT
2919 #define HANDLE_FLAG_INHERIT 1
2920 #endif
2921
2922 HANDLE winsock_lib;
2923 static int winsock_inuse;
2924
2925 BOOL
2926 term_winsock (void)
2927 {
2928 if (winsock_lib != NULL && winsock_inuse == 0)
2929 {
2930 /* Not sure what would cause WSAENETDOWN, or even if it can happen
2931 after WSAStartup returns successfully, but it seems reasonable
2932 to allow unloading winsock anyway in that case. */
2933 if (pfn_WSACleanup () == 0 ||
2934 pfn_WSAGetLastError () == WSAENETDOWN)
2935 {
2936 if (FreeLibrary (winsock_lib))
2937 winsock_lib = NULL;
2938 return TRUE;
2939 }
2940 }
2941 return FALSE;
2942 }
2943
2944 BOOL
2945 init_winsock (int load_now)
2946 {
2947 WSADATA winsockData;
2948
2949 if (winsock_lib != NULL)
2950 return TRUE;
2951
2952 pfn_SetHandleInformation = NULL;
2953 pfn_SetHandleInformation
2954 = (void *) GetProcAddress (GetModuleHandle ("kernel32.dll"),
2955 "SetHandleInformation");
2956
2957 winsock_lib = LoadLibrary ("Ws2_32.dll");
2958
2959 if (winsock_lib != NULL)
2960 {
2961 /* dynamically link to socket functions */
2962
2963 #define LOAD_PROC(fn) \
2964 if ((pfn_##fn = (void *) GetProcAddress (winsock_lib, #fn)) == NULL) \
2965 goto fail;
2966
2967 LOAD_PROC( WSAStartup );
2968 LOAD_PROC( WSASetLastError );
2969 LOAD_PROC( WSAGetLastError );
2970 LOAD_PROC( WSAEventSelect );
2971 LOAD_PROC( WSACreateEvent );
2972 LOAD_PROC( WSACloseEvent );
2973 LOAD_PROC( socket );
2974 LOAD_PROC( bind );
2975 LOAD_PROC( connect );
2976 LOAD_PROC( ioctlsocket );
2977 LOAD_PROC( recv );
2978 LOAD_PROC( send );
2979 LOAD_PROC( closesocket );
2980 LOAD_PROC( shutdown );
2981 LOAD_PROC( htons );
2982 LOAD_PROC( ntohs );
2983 LOAD_PROC( inet_addr );
2984 LOAD_PROC( gethostname );
2985 LOAD_PROC( gethostbyname );
2986 LOAD_PROC( getservbyname );
2987 LOAD_PROC( getpeername );
2988 LOAD_PROC( WSACleanup );
2989 LOAD_PROC( setsockopt );
2990 LOAD_PROC( listen );
2991 LOAD_PROC( getsockname );
2992 LOAD_PROC( accept );
2993 LOAD_PROC( recvfrom );
2994 LOAD_PROC( sendto );
2995 #undef LOAD_PROC
2996
2997 /* specify version 1.1 of winsock */
2998 if (pfn_WSAStartup (0x101, &winsockData) == 0)
2999 {
3000 if (winsockData.wVersion != 0x101)
3001 goto fail;
3002
3003 if (!load_now)
3004 {
3005 /* Report that winsock exists and is usable, but leave
3006 socket functions disabled. I am assuming that calling
3007 WSAStartup does not require any network interaction,
3008 and in particular does not cause or require a dial-up
3009 connection to be established. */
3010
3011 pfn_WSACleanup ();
3012 FreeLibrary (winsock_lib);
3013 winsock_lib = NULL;
3014 }
3015 winsock_inuse = 0;
3016 return TRUE;
3017 }
3018
3019 fail:
3020 FreeLibrary (winsock_lib);
3021 winsock_lib = NULL;
3022 }
3023
3024 return FALSE;
3025 }
3026
3027
3028 int h_errno = 0;
3029
3030 /* function to set h_errno for compatability; map winsock error codes to
3031 normal system codes where they overlap (non-overlapping definitions
3032 are already in <sys/socket.h> */
3033 static void
3034 set_errno ()
3035 {
3036 if (winsock_lib == NULL)
3037 h_errno = EINVAL;
3038 else
3039 h_errno = pfn_WSAGetLastError ();
3040
3041 switch (h_errno)
3042 {
3043 case WSAEACCES: h_errno = EACCES; break;
3044 case WSAEBADF: h_errno = EBADF; break;
3045 case WSAEFAULT: h_errno = EFAULT; break;
3046 case WSAEINTR: h_errno = EINTR; break;
3047 case WSAEINVAL: h_errno = EINVAL; break;
3048 case WSAEMFILE: h_errno = EMFILE; break;
3049 case WSAENAMETOOLONG: h_errno = ENAMETOOLONG; break;
3050 case WSAENOTEMPTY: h_errno = ENOTEMPTY; break;
3051 }
3052 errno = h_errno;
3053 }
3054
3055 static void
3056 check_errno ()
3057 {
3058 if (h_errno == 0 && winsock_lib != NULL)
3059 pfn_WSASetLastError (0);
3060 }
3061
3062 /* Extend strerror to handle the winsock-specific error codes. */
3063 struct {
3064 int errnum;
3065 char * msg;
3066 } _wsa_errlist[] = {
3067 WSAEINTR , "Interrupted function call",
3068 WSAEBADF , "Bad file descriptor",
3069 WSAEACCES , "Permission denied",
3070 WSAEFAULT , "Bad address",
3071 WSAEINVAL , "Invalid argument",
3072 WSAEMFILE , "Too many open files",
3073
3074 WSAEWOULDBLOCK , "Resource temporarily unavailable",
3075 WSAEINPROGRESS , "Operation now in progress",
3076 WSAEALREADY , "Operation already in progress",
3077 WSAENOTSOCK , "Socket operation on non-socket",
3078 WSAEDESTADDRREQ , "Destination address required",
3079 WSAEMSGSIZE , "Message too long",
3080 WSAEPROTOTYPE , "Protocol wrong type for socket",
3081 WSAENOPROTOOPT , "Bad protocol option",
3082 WSAEPROTONOSUPPORT , "Protocol not supported",
3083 WSAESOCKTNOSUPPORT , "Socket type not supported",
3084 WSAEOPNOTSUPP , "Operation not supported",
3085 WSAEPFNOSUPPORT , "Protocol family not supported",
3086 WSAEAFNOSUPPORT , "Address family not supported by protocol family",
3087 WSAEADDRINUSE , "Address already in use",
3088 WSAEADDRNOTAVAIL , "Cannot assign requested address",
3089 WSAENETDOWN , "Network is down",
3090 WSAENETUNREACH , "Network is unreachable",
3091 WSAENETRESET , "Network dropped connection on reset",
3092 WSAECONNABORTED , "Software caused connection abort",
3093 WSAECONNRESET , "Connection reset by peer",
3094 WSAENOBUFS , "No buffer space available",
3095 WSAEISCONN , "Socket is already connected",
3096 WSAENOTCONN , "Socket is not connected",
3097 WSAESHUTDOWN , "Cannot send after socket shutdown",
3098 WSAETOOMANYREFS , "Too many references", /* not sure */
3099 WSAETIMEDOUT , "Connection timed out",
3100 WSAECONNREFUSED , "Connection refused",
3101 WSAELOOP , "Network loop", /* not sure */
3102 WSAENAMETOOLONG , "Name is too long",
3103 WSAEHOSTDOWN , "Host is down",
3104 WSAEHOSTUNREACH , "No route to host",
3105 WSAENOTEMPTY , "Buffer not empty", /* not sure */
3106 WSAEPROCLIM , "Too many processes",
3107 WSAEUSERS , "Too many users", /* not sure */
3108 WSAEDQUOT , "Double quote in host name", /* really not sure */
3109 WSAESTALE , "Data is stale", /* not sure */
3110 WSAEREMOTE , "Remote error", /* not sure */
3111
3112 WSASYSNOTREADY , "Network subsystem is unavailable",
3113 WSAVERNOTSUPPORTED , "WINSOCK.DLL version out of range",
3114 WSANOTINITIALISED , "Winsock not initialized successfully",
3115 WSAEDISCON , "Graceful shutdown in progress",
3116 #ifdef WSAENOMORE
3117 WSAENOMORE , "No more operations allowed", /* not sure */
3118 WSAECANCELLED , "Operation cancelled", /* not sure */
3119 WSAEINVALIDPROCTABLE , "Invalid procedure table from service provider",
3120 WSAEINVALIDPROVIDER , "Invalid service provider version number",
3121 WSAEPROVIDERFAILEDINIT , "Unable to initialize a service provider",
3122 WSASYSCALLFAILURE , "System call failure",
3123 WSASERVICE_NOT_FOUND , "Service not found", /* not sure */
3124 WSATYPE_NOT_FOUND , "Class type not found",
3125 WSA_E_NO_MORE , "No more resources available", /* really not sure */
3126 WSA_E_CANCELLED , "Operation already cancelled", /* really not sure */
3127 WSAEREFUSED , "Operation refused", /* not sure */
3128 #endif
3129
3130 WSAHOST_NOT_FOUND , "Host not found",
3131 WSATRY_AGAIN , "Authoritative host not found during name lookup",
3132 WSANO_RECOVERY , "Non-recoverable error during name lookup",
3133 WSANO_DATA , "Valid name, no data record of requested type",
3134
3135 -1, NULL
3136 };
3137
3138 char *
3139 sys_strerror(int error_no)
3140 {
3141 int i;
3142 static char unknown_msg[40];
3143
3144 if (error_no >= 0 && error_no < sys_nerr)
3145 return sys_errlist[error_no];
3146
3147 for (i = 0; _wsa_errlist[i].errnum >= 0; i++)
3148 if (_wsa_errlist[i].errnum == error_no)
3149 return _wsa_errlist[i].msg;
3150
3151 sprintf(unknown_msg, "Unidentified error: %d", error_no);
3152 return unknown_msg;
3153 }
3154
3155 /* [andrewi 3-May-96] I've had conflicting results using both methods,
3156 but I believe the method of keeping the socket handle separate (and
3157 insuring it is not inheritable) is the correct one. */
3158
3159 //#define SOCK_REPLACE_HANDLE
3160
3161 #ifdef SOCK_REPLACE_HANDLE
3162 #define SOCK_HANDLE(fd) ((SOCKET) _get_osfhandle (fd))
3163 #else
3164 #define SOCK_HANDLE(fd) ((SOCKET) fd_info[fd].hnd)
3165 #endif
3166
3167 int socket_to_fd (SOCKET s);
3168
3169 int
3170 sys_socket(int af, int type, int protocol)
3171 {
3172 SOCKET s;
3173
3174 if (winsock_lib == NULL)
3175 {
3176 h_errno = ENETDOWN;
3177 return INVALID_SOCKET;
3178 }
3179
3180 check_errno ();
3181
3182 /* call the real socket function */
3183 s = pfn_socket (af, type, protocol);
3184
3185 if (s != INVALID_SOCKET)
3186 return socket_to_fd (s);
3187
3188 set_errno ();
3189 return -1;
3190 }
3191
3192 /* Convert a SOCKET to a file descriptor. */
3193 int
3194 socket_to_fd (SOCKET s)
3195 {
3196 int fd;
3197 child_process * cp;
3198
3199 /* Although under NT 3.5 _open_osfhandle will accept a socket
3200 handle, if opened with SO_OPENTYPE == SO_SYNCHRONOUS_NONALERT,
3201 that does not work under NT 3.1. However, we can get the same
3202 effect by using a backdoor function to replace an existing
3203 descriptor handle with the one we want. */
3204
3205 /* allocate a file descriptor (with appropriate flags) */
3206 fd = _open ("NUL:", _O_RDWR);
3207 if (fd >= 0)
3208 {
3209 #ifdef SOCK_REPLACE_HANDLE
3210 /* now replace handle to NUL with our socket handle */
3211 CloseHandle ((HANDLE) _get_osfhandle (fd));
3212 _free_osfhnd (fd);
3213 _set_osfhnd (fd, s);
3214 /* setmode (fd, _O_BINARY); */
3215 #else
3216 /* Make a non-inheritable copy of the socket handle. Note
3217 that it is possible that sockets aren't actually kernel
3218 handles, which appears to be the case on Windows 9x when
3219 the MS Proxy winsock client is installed. */
3220 {
3221 /* Apparently there is a bug in NT 3.51 with some service
3222 packs, which prevents using DuplicateHandle to make a
3223 socket handle non-inheritable (causes WSACleanup to
3224 hang). The work-around is to use SetHandleInformation
3225 instead if it is available and implemented. */
3226 if (pfn_SetHandleInformation)
3227 {
3228 pfn_SetHandleInformation ((HANDLE) s, HANDLE_FLAG_INHERIT, 0);
3229 }
3230 else
3231 {
3232 HANDLE parent = GetCurrentProcess ();
3233 HANDLE new_s = INVALID_HANDLE_VALUE;
3234
3235 if (DuplicateHandle (parent,
3236 (HANDLE) s,
3237 parent,
3238 &new_s,
3239 0,
3240 FALSE,
3241 DUPLICATE_SAME_ACCESS))
3242 {
3243 /* It is possible that DuplicateHandle succeeds even
3244 though the socket wasn't really a kernel handle,
3245 because a real handle has the same value. So
3246 test whether the new handle really is a socket. */
3247 long nonblocking = 0;
3248 if (pfn_ioctlsocket ((SOCKET) new_s, FIONBIO, &nonblocking) == 0)
3249 {
3250 pfn_closesocket (s);
3251 s = (SOCKET) new_s;
3252 }
3253 else
3254 {
3255 CloseHandle (new_s);
3256 }
3257 }
3258 }
3259 }
3260 fd_info[fd].hnd = (HANDLE) s;
3261 #endif
3262
3263 /* set our own internal flags */
3264 fd_info[fd].flags = FILE_SOCKET | FILE_BINARY | FILE_READ | FILE_WRITE;
3265
3266 cp = new_child ();
3267 if (cp)
3268 {
3269 cp->fd = fd;
3270 cp->status = STATUS_READ_ACKNOWLEDGED;
3271
3272 /* attach child_process to fd_info */
3273 if (fd_info[ fd ].cp != NULL)
3274 {
3275 DebPrint (("sys_socket: fd_info[%d] apparently in use!\n", fd));
3276 abort ();
3277 }
3278
3279 fd_info[ fd ].cp = cp;
3280
3281 /* success! */
3282 winsock_inuse++; /* count open sockets */
3283 return fd;
3284 }
3285
3286 /* clean up */
3287 _close (fd);
3288 }
3289 pfn_closesocket (s);
3290 h_errno = EMFILE;
3291 return -1;
3292 }
3293
3294
3295 int
3296 sys_bind (int s, const struct sockaddr * addr, int namelen)
3297 {
3298 if (winsock_lib == NULL)
3299 {
3300 h_errno = ENOTSOCK;
3301 return SOCKET_ERROR;
3302 }
3303
3304 check_errno ();
3305 if (fd_info[s].flags & FILE_SOCKET)
3306 {
3307 int rc = pfn_bind (SOCK_HANDLE (s), addr, namelen);
3308 if (rc == SOCKET_ERROR)
3309 set_errno ();
3310 return rc;
3311 }
3312 h_errno = ENOTSOCK;
3313 return SOCKET_ERROR;
3314 }
3315
3316
3317 int
3318 sys_connect (int s, const struct sockaddr * name, int namelen)
3319 {
3320 if (winsock_lib == NULL)
3321 {
3322 h_errno = ENOTSOCK;
3323 return SOCKET_ERROR;
3324 }
3325
3326 check_errno ();
3327 if (fd_info[s].flags & FILE_SOCKET)
3328 {
3329 int rc = pfn_connect (SOCK_HANDLE (s), name, namelen);
3330 if (rc == SOCKET_ERROR)
3331 set_errno ();
3332 return rc;
3333 }
3334 h_errno = ENOTSOCK;
3335 return SOCKET_ERROR;
3336 }
3337
3338 u_short
3339 sys_htons (u_short hostshort)
3340 {
3341 return (winsock_lib != NULL) ?
3342 pfn_htons (hostshort) : hostshort;
3343 }
3344
3345 u_short
3346 sys_ntohs (u_short netshort)
3347 {
3348 return (winsock_lib != NULL) ?
3349 pfn_ntohs (netshort) : netshort;
3350 }
3351
3352 unsigned long
3353 sys_inet_addr (const char * cp)
3354 {
3355 return (winsock_lib != NULL) ?
3356 pfn_inet_addr (cp) : INADDR_NONE;
3357 }
3358
3359 int
3360 sys_gethostname (char * name, int namelen)
3361 {
3362 if (winsock_lib != NULL)
3363 return pfn_gethostname (name, namelen);
3364
3365 if (namelen > MAX_COMPUTERNAME_LENGTH)
3366 return !GetComputerName (name, (DWORD *)&namelen);
3367
3368 h_errno = EFAULT;
3369 return SOCKET_ERROR;
3370 }
3371
3372 struct hostent *
3373 sys_gethostbyname(const char * name)
3374 {
3375 struct hostent * host;
3376
3377 if (winsock_lib == NULL)
3378 {
3379 h_errno = ENETDOWN;
3380 return NULL;
3381 }
3382
3383 check_errno ();
3384 host = pfn_gethostbyname (name);
3385 if (!host)
3386 set_errno ();
3387 return host;
3388 }
3389
3390 struct servent *
3391 sys_getservbyname(const char * name, const char * proto)
3392 {
3393 struct servent * serv;
3394
3395 if (winsock_lib == NULL)
3396 {
3397 h_errno = ENETDOWN;
3398 return NULL;
3399 }
3400
3401 check_errno ();
3402 serv = pfn_getservbyname (name, proto);
3403 if (!serv)
3404 set_errno ();
3405 return serv;
3406 }
3407
3408 int
3409 sys_getpeername (int s, struct sockaddr *addr, int * namelen)
3410 {
3411 if (winsock_lib == NULL)
3412 {
3413 h_errno = ENETDOWN;
3414 return SOCKET_ERROR;
3415 }
3416
3417 check_errno ();
3418 if (fd_info[s].flags & FILE_SOCKET)
3419 {
3420 int rc = pfn_getpeername (SOCK_HANDLE (s), addr, namelen);
3421 if (rc == SOCKET_ERROR)
3422 set_errno ();
3423 return rc;
3424 }
3425 h_errno = ENOTSOCK;
3426 return SOCKET_ERROR;
3427 }
3428
3429
3430 int
3431 sys_shutdown (int s, int how)
3432 {
3433 if (winsock_lib == NULL)
3434 {
3435 h_errno = ENETDOWN;
3436 return SOCKET_ERROR;
3437 }
3438
3439 check_errno ();
3440 if (fd_info[s].flags & FILE_SOCKET)
3441 {
3442 int rc = pfn_shutdown (SOCK_HANDLE (s), how);
3443 if (rc == SOCKET_ERROR)
3444 set_errno ();
3445 return rc;
3446 }
3447 h_errno = ENOTSOCK;
3448 return SOCKET_ERROR;
3449 }
3450
3451 int
3452 sys_setsockopt (int s, int level, int optname, const void * optval, int optlen)
3453 {
3454 if (winsock_lib == NULL)
3455 {
3456 h_errno = ENETDOWN;
3457 return SOCKET_ERROR;
3458 }
3459
3460 check_errno ();
3461 if (fd_info[s].flags & FILE_SOCKET)
3462 {
3463 int rc = pfn_setsockopt (SOCK_HANDLE (s), level, optname,
3464 (const char *)optval, optlen);
3465 if (rc == SOCKET_ERROR)
3466 set_errno ();
3467 return rc;
3468 }
3469 h_errno = ENOTSOCK;
3470 return SOCKET_ERROR;
3471 }
3472
3473 int
3474 sys_listen (int s, int backlog)
3475 {
3476 if (winsock_lib == NULL)
3477 {
3478 h_errno = ENETDOWN;
3479 return SOCKET_ERROR;
3480 }
3481
3482 check_errno ();
3483 if (fd_info[s].flags & FILE_SOCKET)
3484 {
3485 int rc = pfn_listen (SOCK_HANDLE (s), backlog);
3486 if (rc == SOCKET_ERROR)
3487 set_errno ();
3488 else
3489 fd_info[s].flags |= FILE_LISTEN;
3490 return rc;
3491 }
3492 h_errno = ENOTSOCK;
3493 return SOCKET_ERROR;
3494 }
3495
3496 int
3497 sys_getsockname (int s, struct sockaddr * name, int * namelen)
3498 {
3499 if (winsock_lib == NULL)
3500 {
3501 h_errno = ENETDOWN;
3502 return SOCKET_ERROR;
3503 }
3504
3505 check_errno ();
3506 if (fd_info[s].flags & FILE_SOCKET)
3507 {
3508 int rc = pfn_getsockname (SOCK_HANDLE (s), name, namelen);
3509 if (rc == SOCKET_ERROR)
3510 set_errno ();
3511 return rc;
3512 }
3513 h_errno = ENOTSOCK;
3514 return SOCKET_ERROR;
3515 }
3516
3517 int
3518 sys_accept (int s, struct sockaddr * addr, int * addrlen)
3519 {
3520 if (winsock_lib == NULL)
3521 {
3522 h_errno = ENETDOWN;
3523 return -1;
3524 }
3525
3526 check_errno ();
3527 if (fd_info[s].flags & FILE_LISTEN)
3528 {
3529 SOCKET t = pfn_accept (SOCK_HANDLE (s), addr, addrlen);
3530 int fd = -1;
3531 if (t == INVALID_SOCKET)
3532 set_errno ();
3533 else
3534 fd = socket_to_fd (t);
3535
3536 fd_info[s].cp->status = STATUS_READ_ACKNOWLEDGED;
3537 ResetEvent (fd_info[s].cp->char_avail);
3538 return fd;
3539 }
3540 h_errno = ENOTSOCK;
3541 return -1;
3542 }
3543
3544 int
3545 sys_recvfrom (int s, char * buf, int len, int flags,
3546 struct sockaddr * from, int * fromlen)
3547 {
3548 if (winsock_lib == NULL)
3549 {
3550 h_errno = ENETDOWN;
3551 return SOCKET_ERROR;
3552 }
3553
3554 check_errno ();
3555 if (fd_info[s].flags & FILE_SOCKET)
3556 {
3557 int rc = pfn_recvfrom (SOCK_HANDLE (s), buf, len, flags, from, fromlen);
3558 if (rc == SOCKET_ERROR)
3559 set_errno ();
3560 return rc;
3561 }
3562 h_errno = ENOTSOCK;
3563 return SOCKET_ERROR;
3564 }
3565
3566 int
3567 sys_sendto (int s, const char * buf, int len, int flags,
3568 const struct sockaddr * to, int tolen)
3569 {
3570 if (winsock_lib == NULL)
3571 {
3572 h_errno = ENETDOWN;
3573 return SOCKET_ERROR;
3574 }
3575
3576 check_errno ();
3577 if (fd_info[s].flags & FILE_SOCKET)
3578 {
3579 int rc = pfn_sendto (SOCK_HANDLE (s), buf, len, flags, to, tolen);
3580 if (rc == SOCKET_ERROR)
3581 set_errno ();
3582 return rc;
3583 }
3584 h_errno = ENOTSOCK;
3585 return SOCKET_ERROR;
3586 }
3587
3588 /* Windows does not have an fcntl function. Provide an implementation
3589 solely for making sockets non-blocking. */
3590 int
3591 fcntl (int s, int cmd, int options)
3592 {
3593 if (winsock_lib == NULL)
3594 {
3595 h_errno = ENETDOWN;
3596 return -1;
3597 }
3598
3599 check_errno ();
3600 if (fd_info[s].flags & FILE_SOCKET)
3601 {
3602 if (cmd == F_SETFL && options == O_NDELAY)
3603 {
3604 unsigned long nblock = 1;
3605 int rc = pfn_ioctlsocket (SOCK_HANDLE (s), FIONBIO, &nblock);
3606 if (rc == SOCKET_ERROR)
3607 set_errno();
3608 /* Keep track of the fact that we set this to non-blocking. */
3609 fd_info[s].flags |= FILE_NDELAY;
3610 return rc;
3611 }
3612 else
3613 {
3614 h_errno = EINVAL;
3615 return SOCKET_ERROR;
3616 }
3617 }
3618 h_errno = ENOTSOCK;
3619 return SOCKET_ERROR;
3620 }
3621
3622 #endif /* HAVE_SOCKETS */
3623
3624
3625 /* Shadow main io functions: we need to handle pipes and sockets more
3626 intelligently, and implement non-blocking mode as well. */
3627
3628 int
3629 sys_close (int fd)
3630 {
3631 int rc;
3632
3633 if (fd < 0)
3634 {
3635 errno = EBADF;
3636 return -1;
3637 }
3638
3639 if (fd < MAXDESC && fd_info[fd].cp)
3640 {
3641 child_process * cp = fd_info[fd].cp;
3642
3643 fd_info[fd].cp = NULL;
3644
3645 if (CHILD_ACTIVE (cp))
3646 {
3647 /* if last descriptor to active child_process then cleanup */
3648 int i;
3649 for (i = 0; i < MAXDESC; i++)
3650 {
3651 if (i == fd)
3652 continue;
3653 if (fd_info[i].cp == cp)
3654 break;
3655 }
3656 if (i == MAXDESC)
3657 {
3658 #ifdef HAVE_SOCKETS
3659 if (fd_info[fd].flags & FILE_SOCKET)
3660 {
3661 #ifndef SOCK_REPLACE_HANDLE
3662 if (winsock_lib == NULL) abort ();
3663
3664 pfn_shutdown (SOCK_HANDLE (fd), 2);
3665 rc = pfn_closesocket (SOCK_HANDLE (fd));
3666 #endif
3667 winsock_inuse--; /* count open sockets */
3668 }
3669 #endif
3670 delete_child (cp);
3671 }
3672 }
3673 }
3674
3675 /* Note that sockets do not need special treatment here (at least on
3676 NT and Windows 95 using the standard tcp/ip stacks) - it appears that
3677 closesocket is equivalent to CloseHandle, which is to be expected
3678 because socket handles are fully fledged kernel handles. */
3679 rc = _close (fd);
3680
3681 if (rc == 0 && fd < MAXDESC)
3682 fd_info[fd].flags = 0;
3683
3684 return rc;
3685 }
3686
3687 int
3688 sys_dup (int fd)
3689 {
3690 int new_fd;
3691
3692 new_fd = _dup (fd);
3693 if (new_fd >= 0 && new_fd < MAXDESC)
3694 {
3695 /* duplicate our internal info as well */
3696 fd_info[new_fd] = fd_info[fd];
3697 }
3698 return new_fd;
3699 }
3700
3701
3702 int
3703 sys_dup2 (int src, int dst)
3704 {
3705 int rc;
3706
3707 if (dst < 0 || dst >= MAXDESC)
3708 {
3709 errno = EBADF;
3710 return -1;
3711 }
3712
3713 /* make sure we close the destination first if it's a pipe or socket */
3714 if (src != dst && fd_info[dst].flags != 0)
3715 sys_close (dst);
3716
3717 rc = _dup2 (src, dst);
3718 if (rc == 0)
3719 {
3720 /* duplicate our internal info as well */
3721 fd_info[dst] = fd_info[src];
3722 }
3723 return rc;
3724 }
3725
3726 /* Unix pipe() has only one arg */
3727 int
3728 sys_pipe (int * phandles)
3729 {
3730 int rc;
3731 unsigned flags;
3732
3733 /* make pipe handles non-inheritable; when we spawn a child, we
3734 replace the relevant handle with an inheritable one. Also put
3735 pipes into binary mode; we will do text mode translation ourselves
3736 if required. */
3737 rc = _pipe (phandles, 0, _O_NOINHERIT | _O_BINARY);
3738
3739 if (rc == 0)
3740 {
3741 /* Protect against overflow, since Windows can open more handles than
3742 our fd_info array has room for. */
3743 if (phandles[0] >= MAXDESC || phandles[1] >= MAXDESC)
3744 {
3745 _close (phandles[0]);
3746 _close (phandles[1]);
3747 rc = -1;
3748 }
3749 else
3750 {
3751 flags = FILE_PIPE | FILE_READ | FILE_BINARY;
3752 fd_info[phandles[0]].flags = flags;
3753
3754 flags = FILE_PIPE | FILE_WRITE | FILE_BINARY;
3755 fd_info[phandles[1]].flags = flags;
3756 }
3757 }
3758
3759 return rc;
3760 }
3761
3762 /* From ntproc.c */
3763 extern int w32_pipe_read_delay;
3764
3765 /* Function to do blocking read of one byte, needed to implement
3766 select. It is only allowed on sockets and pipes. */
3767 int
3768 _sys_read_ahead (int fd)
3769 {
3770 child_process * cp;
3771 int rc;
3772
3773 if (fd < 0 || fd >= MAXDESC)
3774 return STATUS_READ_ERROR;
3775
3776 cp = fd_info[fd].cp;
3777
3778 if (cp == NULL || cp->fd != fd || cp->status != STATUS_READ_READY)
3779 return STATUS_READ_ERROR;
3780
3781 if ((fd_info[fd].flags & (FILE_PIPE | FILE_SOCKET)) == 0
3782 || (fd_info[fd].flags & FILE_READ) == 0)
3783 {
3784 DebPrint (("_sys_read_ahead: internal error: fd %d is not a pipe or socket!\n", fd));
3785 abort ();
3786 }
3787
3788 cp->status = STATUS_READ_IN_PROGRESS;
3789
3790 if (fd_info[fd].flags & FILE_PIPE)
3791 {
3792 rc = _read (fd, &cp->chr, sizeof (char));
3793
3794 /* Give subprocess time to buffer some more output for us before
3795 reporting that input is available; we need this because Windows 95
3796 connects DOS programs to pipes by making the pipe appear to be
3797 the normal console stdout - as a result most DOS programs will
3798 write to stdout without buffering, ie. one character at a
3799 time. Even some W32 programs do this - "dir" in a command
3800 shell on NT is very slow if we don't do this. */
3801 if (rc > 0)
3802 {
3803 int wait = w32_pipe_read_delay;
3804
3805 if (wait > 0)
3806 Sleep (wait);
3807 else if (wait < 0)
3808 while (++wait <= 0)
3809 /* Yield remainder of our time slice, effectively giving a
3810 temporary priority boost to the child process. */
3811 Sleep (0);
3812 }
3813 }
3814 #ifdef HAVE_SOCKETS
3815 else if (fd_info[fd].flags & FILE_SOCKET)
3816 {
3817 unsigned long nblock = 0;
3818 /* We always want this to block, so temporarily disable NDELAY. */
3819 if (fd_info[fd].flags & FILE_NDELAY)
3820 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
3821
3822 rc = pfn_recv (SOCK_HANDLE (fd), &cp->chr, sizeof (char), 0);
3823
3824 if (fd_info[fd].flags & FILE_NDELAY)
3825 {
3826 nblock = 1;
3827 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
3828 }
3829 }
3830 #endif
3831
3832 if (rc == sizeof (char))
3833 cp->status = STATUS_READ_SUCCEEDED;
3834 else
3835 cp->status = STATUS_READ_FAILED;
3836
3837 return cp->status;
3838 }
3839
3840 int
3841 _sys_wait_accept (int fd)
3842 {
3843 HANDLE hEv;
3844 child_process * cp;
3845 int rc;
3846
3847 if (fd < 0 || fd >= MAXDESC)
3848 return STATUS_READ_ERROR;
3849
3850 cp = fd_info[fd].cp;
3851
3852 if (cp == NULL || cp->fd != fd || cp->status != STATUS_READ_READY)
3853 return STATUS_READ_ERROR;
3854
3855 cp->status = STATUS_READ_FAILED;
3856
3857 hEv = pfn_WSACreateEvent ();
3858 rc = pfn_WSAEventSelect (SOCK_HANDLE (fd), hEv, FD_ACCEPT);
3859 if (rc != SOCKET_ERROR)
3860 {
3861 rc = WaitForSingleObject (hEv, INFINITE);
3862 pfn_WSAEventSelect (SOCK_HANDLE (fd), NULL, 0);
3863 if (rc == WAIT_OBJECT_0)
3864 cp->status = STATUS_READ_SUCCEEDED;
3865 }
3866 pfn_WSACloseEvent (hEv);
3867
3868 return cp->status;
3869 }
3870
3871 int
3872 sys_read (int fd, char * buffer, unsigned int count)
3873 {
3874 int nchars;
3875 int to_read;
3876 DWORD waiting;
3877 char * orig_buffer = buffer;
3878
3879 if (fd < 0)
3880 {
3881 errno = EBADF;
3882 return -1;
3883 }
3884
3885 if (fd < MAXDESC && fd_info[fd].flags & (FILE_PIPE | FILE_SOCKET))
3886 {
3887 child_process *cp = fd_info[fd].cp;
3888
3889 if ((fd_info[fd].flags & FILE_READ) == 0)
3890 {
3891 errno = EBADF;
3892 return -1;
3893 }
3894
3895 nchars = 0;
3896
3897 /* re-read CR carried over from last read */
3898 if (fd_info[fd].flags & FILE_LAST_CR)
3899 {
3900 if (fd_info[fd].flags & FILE_BINARY) abort ();
3901 *buffer++ = 0x0d;
3902 count--;
3903 nchars++;
3904 fd_info[fd].flags &= ~FILE_LAST_CR;
3905 }
3906
3907 /* presence of a child_process structure means we are operating in
3908 non-blocking mode - otherwise we just call _read directly.
3909 Note that the child_process structure might be missing because
3910 reap_subprocess has been called; in this case the pipe is
3911 already broken, so calling _read on it is okay. */
3912 if (cp)
3913 {
3914 int current_status = cp->status;
3915
3916 switch (current_status)
3917 {
3918 case STATUS_READ_FAILED:
3919 case STATUS_READ_ERROR:
3920 /* report normal EOF if nothing in buffer */
3921 if (nchars <= 0)
3922 fd_info[fd].flags |= FILE_AT_EOF;
3923 return nchars;
3924
3925 case STATUS_READ_READY:
3926 case STATUS_READ_IN_PROGRESS:
3927 DebPrint (("sys_read called when read is in progress\n"));
3928 errno = EWOULDBLOCK;
3929 return -1;
3930
3931 case STATUS_READ_SUCCEEDED:
3932 /* consume read-ahead char */
3933 *buffer++ = cp->chr;
3934 count--;
3935 nchars++;
3936 cp->status = STATUS_READ_ACKNOWLEDGED;
3937 ResetEvent (cp->char_avail);
3938
3939 case STATUS_READ_ACKNOWLEDGED:
3940 break;
3941
3942 default:
3943 DebPrint (("sys_read: bad status %d\n", current_status));
3944 errno = EBADF;
3945 return -1;
3946 }
3947
3948 if (fd_info[fd].flags & FILE_PIPE)
3949 {
3950 PeekNamedPipe ((HANDLE) _get_osfhandle (fd), NULL, 0, NULL, &waiting, NULL);
3951 to_read = min (waiting, (DWORD) count);
3952
3953 if (to_read > 0)
3954 nchars += _read (fd, buffer, to_read);
3955 }
3956 #ifdef HAVE_SOCKETS
3957 else /* FILE_SOCKET */
3958 {
3959 if (winsock_lib == NULL) abort ();
3960
3961 /* do the equivalent of a non-blocking read */
3962 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONREAD, &waiting);
3963 if (waiting == 0 && nchars == 0)
3964 {
3965 h_errno = errno = EWOULDBLOCK;
3966 return -1;
3967 }
3968
3969 if (waiting)
3970 {
3971 /* always use binary mode for sockets */
3972 int res = pfn_recv (SOCK_HANDLE (fd), buffer, count, 0);
3973 if (res == SOCKET_ERROR)
3974 {
3975 DebPrint(("sys_read.recv failed with error %d on socket %ld\n",
3976 pfn_WSAGetLastError (), SOCK_HANDLE (fd)));
3977 set_errno ();
3978 return -1;
3979 }
3980 nchars += res;
3981 }
3982 }
3983 #endif
3984 }
3985 else
3986 {
3987 int nread = _read (fd, buffer, count);
3988 if (nread >= 0)
3989 nchars += nread;
3990 else if (nchars == 0)
3991 nchars = nread;
3992 }
3993
3994 if (nchars <= 0)
3995 fd_info[fd].flags |= FILE_AT_EOF;
3996 /* Perform text mode translation if required. */
3997 else if ((fd_info[fd].flags & FILE_BINARY) == 0)
3998 {
3999 nchars = crlf_to_lf (nchars, orig_buffer);
4000 /* If buffer contains only CR, return that. To be absolutely
4001 sure we should attempt to read the next char, but in
4002 practice a CR to be followed by LF would not appear by
4003 itself in the buffer. */
4004 if (nchars > 1 && orig_buffer[nchars - 1] == 0x0d)
4005 {
4006 fd_info[fd].flags |= FILE_LAST_CR;
4007 nchars--;
4008 }
4009 }
4010 }
4011 else
4012 nchars = _read (fd, buffer, count);
4013
4014 return nchars;
4015 }
4016
4017 /* For now, don't bother with a non-blocking mode */
4018 int
4019 sys_write (int fd, const void * buffer, unsigned int count)
4020 {
4021 int nchars;
4022
4023 if (fd < 0)
4024 {
4025 errno = EBADF;
4026 return -1;
4027 }
4028
4029 if (fd < MAXDESC && fd_info[fd].flags & (FILE_PIPE | FILE_SOCKET))
4030 {
4031 if ((fd_info[fd].flags & FILE_WRITE) == 0)
4032 {
4033 errno = EBADF;
4034 return -1;
4035 }
4036
4037 /* Perform text mode translation if required. */
4038 if ((fd_info[fd].flags & FILE_BINARY) == 0)
4039 {
4040 char * tmpbuf = alloca (count * 2);
4041 unsigned char * src = (void *)buffer;
4042 unsigned char * dst = tmpbuf;
4043 int nbytes = count;
4044
4045 while (1)
4046 {
4047 unsigned char *next;
4048 /* copy next line or remaining bytes */
4049 next = _memccpy (dst, src, '\n', nbytes);
4050 if (next)
4051 {
4052 /* copied one line ending with '\n' */
4053 int copied = next - dst;
4054 nbytes -= copied;
4055 src += copied;
4056 /* insert '\r' before '\n' */
4057 next[-1] = '\r';
4058 next[0] = '\n';
4059 dst = next + 1;
4060 count++;
4061 }
4062 else
4063 /* copied remaining partial line -> now finished */
4064 break;
4065 }
4066 buffer = tmpbuf;
4067 }
4068 }
4069
4070 #ifdef HAVE_SOCKETS
4071 if (fd < MAXDESC && fd_info[fd].flags & FILE_SOCKET)
4072 {
4073 unsigned long nblock = 0;
4074 if (winsock_lib == NULL) abort ();
4075
4076 /* TODO: implement select() properly so non-blocking I/O works. */
4077 /* For now, make sure the write blocks. */
4078 if (fd_info[fd].flags & FILE_NDELAY)
4079 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
4080
4081 nchars = pfn_send (SOCK_HANDLE (fd), buffer, count, 0);
4082
4083 /* Set the socket back to non-blocking if it was before,
4084 for other operations that support it. */
4085 if (fd_info[fd].flags & FILE_NDELAY)
4086 {
4087 nblock = 1;
4088 pfn_ioctlsocket (SOCK_HANDLE (fd), FIONBIO, &nblock);
4089 }
4090
4091 if (nchars == SOCKET_ERROR)
4092 {
4093 DebPrint(("sys_write.send failed with error %d on socket %ld\n",
4094 pfn_WSAGetLastError (), SOCK_HANDLE (fd)));
4095 set_errno ();
4096 }
4097 }
4098 else
4099 #endif
4100 nchars = _write (fd, buffer, count);
4101
4102 return nchars;
4103 }
4104
4105 static void
4106 check_windows_init_file ()
4107 {
4108 extern int noninteractive, inhibit_window_system;
4109
4110 /* A common indication that Emacs is not installed properly is when
4111 it cannot find the Windows installation file. If this file does
4112 not exist in the expected place, tell the user. */
4113
4114 if (!noninteractive && !inhibit_window_system)
4115 {
4116 extern Lisp_Object Vwindow_system, Vload_path, Qfile_exists_p;
4117 Lisp_Object objs[2];
4118 Lisp_Object full_load_path;
4119 Lisp_Object init_file;
4120 int fd;
4121
4122 objs[0] = Vload_path;
4123 objs[1] = decode_env_path (0, (getenv ("EMACSLOADPATH")));
4124 full_load_path = Fappend (2, objs);
4125 init_file = build_string ("term/w32-win");
4126 fd = openp (full_load_path, init_file, Fget_load_suffixes (), NULL, Qnil);
4127 if (fd < 0)
4128 {
4129 Lisp_Object load_path_print = Fprin1_to_string (full_load_path, Qnil);
4130 char *init_file_name = SDATA (init_file);
4131 char *load_path = SDATA (load_path_print);
4132 char *buffer = alloca (1024
4133 + strlen (init_file_name)
4134 + strlen (load_path));
4135
4136 sprintf (buffer,
4137 "The Emacs Windows initialization file \"%s.el\" "
4138 "could not be found in your Emacs installation. "
4139 "Emacs checked the following directories for this file:\n"
4140 "\n%s\n\n"
4141 "When Emacs cannot find this file, it usually means that it "
4142 "was not installed properly, or its distribution file was "
4143 "not unpacked properly.\nSee the README.W32 file in the "
4144 "top-level Emacs directory for more information.",
4145 init_file_name, load_path);
4146 MessageBox (NULL,
4147 buffer,
4148 "Emacs Abort Dialog",
4149 MB_OK | MB_ICONEXCLAMATION | MB_TASKMODAL);
4150 /* Use the low-level Emacs abort. */
4151 #undef abort
4152 abort ();
4153 }
4154 else
4155 {
4156 _close (fd);
4157 }
4158 }
4159 }
4160
4161 void
4162 term_ntproc ()
4163 {
4164 #ifdef HAVE_SOCKETS
4165 /* shutdown the socket interface if necessary */
4166 term_winsock ();
4167 #endif
4168
4169 term_w32select ();
4170 }
4171
4172 void
4173 init_ntproc ()
4174 {
4175 #ifdef HAVE_SOCKETS
4176 /* Initialise the socket interface now if available and requested by
4177 the user by defining PRELOAD_WINSOCK; otherwise loading will be
4178 delayed until open-network-stream is called (w32-has-winsock can
4179 also be used to dynamically load or reload winsock).
4180
4181 Conveniently, init_environment is called before us, so
4182 PRELOAD_WINSOCK can be set in the registry. */
4183
4184 /* Always initialize this correctly. */
4185 winsock_lib = NULL;
4186
4187 if (getenv ("PRELOAD_WINSOCK") != NULL)
4188 init_winsock (TRUE);
4189 #endif
4190
4191 /* Initial preparation for subprocess support: replace our standard
4192 handles with non-inheritable versions. */
4193 {
4194 HANDLE parent;
4195 HANDLE stdin_save = INVALID_HANDLE_VALUE;
4196 HANDLE stdout_save = INVALID_HANDLE_VALUE;
4197 HANDLE stderr_save = INVALID_HANDLE_VALUE;
4198
4199 parent = GetCurrentProcess ();
4200
4201 /* ignore errors when duplicating and closing; typically the
4202 handles will be invalid when running as a gui program. */
4203 DuplicateHandle (parent,
4204 GetStdHandle (STD_INPUT_HANDLE),
4205 parent,
4206 &stdin_save,
4207 0,
4208 FALSE,
4209 DUPLICATE_SAME_ACCESS);
4210
4211 DuplicateHandle (parent,
4212 GetStdHandle (STD_OUTPUT_HANDLE),
4213 parent,
4214 &stdout_save,
4215 0,
4216 FALSE,
4217 DUPLICATE_SAME_ACCESS);
4218
4219 DuplicateHandle (parent,
4220 GetStdHandle (STD_ERROR_HANDLE),
4221 parent,
4222 &stderr_save,
4223 0,
4224 FALSE,
4225 DUPLICATE_SAME_ACCESS);
4226
4227 fclose (stdin);
4228 fclose (stdout);
4229 fclose (stderr);
4230
4231 if (stdin_save != INVALID_HANDLE_VALUE)
4232 _open_osfhandle ((long) stdin_save, O_TEXT);
4233 else
4234 _open ("nul", O_TEXT | O_NOINHERIT | O_RDONLY);
4235 _fdopen (0, "r");
4236
4237 if (stdout_save != INVALID_HANDLE_VALUE)
4238 _open_osfhandle ((long) stdout_save, O_TEXT);
4239 else
4240 _open ("nul", O_TEXT | O_NOINHERIT | O_WRONLY);
4241 _fdopen (1, "w");
4242
4243 if (stderr_save != INVALID_HANDLE_VALUE)
4244 _open_osfhandle ((long) stderr_save, O_TEXT);
4245 else
4246 _open ("nul", O_TEXT | O_NOINHERIT | O_WRONLY);
4247 _fdopen (2, "w");
4248 }
4249
4250 /* unfortunately, atexit depends on implementation of malloc */
4251 /* atexit (term_ntproc); */
4252 signal (SIGABRT, term_ntproc);
4253
4254 /* determine which drives are fixed, for GetCachedVolumeInformation */
4255 {
4256 /* GetDriveType must have trailing backslash. */
4257 char drive[] = "A:\\";
4258
4259 /* Loop over all possible drive letters */
4260 while (*drive <= 'Z')
4261 {
4262 /* Record if this drive letter refers to a fixed drive. */
4263 fixed_drives[DRIVE_INDEX (*drive)] =
4264 (GetDriveType (drive) == DRIVE_FIXED);
4265
4266 (*drive)++;
4267 }
4268
4269 /* Reset the volume info cache. */
4270 volume_cache = NULL;
4271 }
4272
4273 /* Check to see if Emacs has been installed correctly. */
4274 check_windows_init_file ();
4275 }
4276
4277 /*
4278 shutdown_handler ensures that buffers' autosave files are
4279 up to date when the user logs off, or the system shuts down.
4280 */
4281 BOOL WINAPI shutdown_handler(DWORD type)
4282 {
4283 /* Ctrl-C and Ctrl-Break are already suppressed, so don't handle them. */
4284 if (type == CTRL_CLOSE_EVENT /* User closes console window. */
4285 || type == CTRL_LOGOFF_EVENT /* User logs off. */
4286 || type == CTRL_SHUTDOWN_EVENT) /* User shutsdown. */
4287 {
4288 /* Shut down cleanly, making sure autosave files are up to date. */
4289 shut_down_emacs (0, 0, Qnil);
4290 }
4291
4292 /* Allow other handlers to handle this signal. */
4293 return FALSE;
4294 }
4295
4296 /*
4297 globals_of_w32 is used to initialize those global variables that
4298 must always be initialized on startup even when the global variable
4299 initialized is non zero (see the function main in emacs.c).
4300 */
4301 void
4302 globals_of_w32 ()
4303 {
4304 HMODULE kernel32 = GetModuleHandle ("kernel32.dll");
4305
4306 get_process_times_fn = (GetProcessTimes_Proc)
4307 GetProcAddress (kernel32, "GetProcessTimes");
4308
4309 g_b_init_is_windows_9x = 0;
4310 g_b_init_open_process_token = 0;
4311 g_b_init_get_token_information = 0;
4312 g_b_init_lookup_account_sid = 0;
4313 g_b_init_get_sid_identifier_authority = 0;
4314 g_b_init_get_sid_sub_authority = 0;
4315 g_b_init_get_sid_sub_authority_count = 0;
4316 /* The following sets a handler for shutdown notifications for
4317 console apps. This actually applies to Emacs in both console and
4318 GUI modes, since we had to fool windows into thinking emacs is a
4319 console application to get console mode to work. */
4320 SetConsoleCtrlHandler(shutdown_handler, TRUE);
4321 }
4322
4323 /* end of w32.c */
4324
4325 /* arch-tag: 90442dd3-37be-482b-b272-ac752e3049f1
4326 (do not change this comment) */