2 * file-io.c: File IO internal calls
5 * Dick Porter (dick@ximian.com)
6 * Gonzalo Paniagua Javier (gonzalo@ximian.com)
8 * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
9 * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
20 #ifdef HAVE_SYS_STAT_H
23 #ifdef HAVE_SYS_TYPES_H
24 #include <sys/types.h>
27 #include <mono/metadata/object.h>
28 #include <mono/io-layer/io-layer.h>
29 #include <mono/metadata/file-io.h>
30 #include <mono/metadata/exception.h>
31 #include <mono/metadata/appdomain.h>
32 #include <mono/metadata/marshal.h>
33 #include <mono/utils/strenc.h>
37 /* conversion functions */
39 static guint32 convert_mode(MonoFileMode mono_mode)
44 case FileMode_CreateNew:
53 case FileMode_OpenOrCreate:
56 case FileMode_Truncate:
57 mode=TRUNCATE_EXISTING;
63 g_warning("System.IO.FileMode has unknown value 0x%x",
72 static guint32 convert_access(MonoFileAccess mono_access)
80 case FileAccess_Write:
83 case FileAccess_ReadWrite:
84 access=GENERIC_READ|GENERIC_WRITE;
87 g_warning("System.IO.FileAccess has unknown value 0x%x",
96 static guint32 convert_share(MonoFileShare mono_share)
100 if (mono_share & FileShare_Read) {
101 share |= FILE_SHARE_READ;
103 if (mono_share & FileShare_Write) {
104 share |= FILE_SHARE_WRITE;
106 if (mono_share & FileShare_Delete) {
107 share |= FILE_SHARE_DELETE;
110 if (mono_share & ~(FileShare_Read|FileShare_Write|FileShare_Delete)) {
111 g_warning("System.IO.FileShare has unknown value 0x%x",
121 static guint32 convert_stdhandle(guint32 fd)
127 stdhandle=STD_INPUT_HANDLE;
130 stdhandle=STD_OUTPUT_HANDLE;
133 stdhandle=STD_ERROR_HANDLE;
136 g_warning("unknown standard file descriptor %d", fd);
137 stdhandle=STD_INPUT_HANDLE;
144 static guint32 convert_seekorigin(MonoSeekOrigin origin)
149 case SeekOrigin_Begin:
150 w32origin=FILE_BEGIN;
152 case SeekOrigin_Current:
153 w32origin=FILE_CURRENT;
159 g_warning("System.IO.SeekOrigin has unknown value 0x%x",
162 w32origin=FILE_CURRENT;
168 static gint64 convert_filetime (const FILETIME *filetime)
170 guint64 ticks = filetime->dwHighDateTime;
172 ticks += filetime->dwLowDateTime;
173 return (gint64)ticks;
176 static void convert_win32_file_attribute_data (const WIN32_FILE_ATTRIBUTE_DATA *data, const gunichar2 *name, MonoIOStat *stat)
180 stat->attributes = data->dwFileAttributes;
181 stat->creation_time = convert_filetime (&data->ftCreationTime);
182 stat->last_access_time = convert_filetime (&data->ftLastAccessTime);
183 stat->last_write_time = convert_filetime (&data->ftLastWriteTime);
184 stat->length = ((gint64)data->nFileSizeHigh << 32) | data->nFileSizeLow;
190 MONO_STRUCT_SETREF (stat, name, mono_string_new_utf16 (mono_domain_get (), name, len));
193 /* Managed file attributes have nearly but not quite the same values
194 * as the w32 equivalents.
196 static guint32 convert_attrs(MonoFileAttributes attrs)
198 if(attrs & FileAttributes_Encrypted) {
199 attrs |= FILE_ATTRIBUTE_ENCRYPTED;
206 * On Win32, GetFileAttributes|Ex () seems to try opening the file,
207 * which might lead to sharing violation errors, whereas FindFirstFile
208 * always succeeds. These 2 wrappers resort to FindFirstFile if
209 * GetFileAttributes|Ex () has failed.
212 get_file_attributes (const gunichar2 *path)
215 WIN32_FIND_DATA find_data;
219 res = GetFileAttributes (path);
223 error = GetLastError ();
225 if (error != ERROR_SHARING_VIOLATION)
228 find_handle = FindFirstFile (path, &find_data);
230 if (find_handle == INVALID_HANDLE_VALUE)
233 FindClose (find_handle);
235 return find_data.dwFileAttributes;
239 get_file_attributes_ex (const gunichar2 *path, WIN32_FILE_ATTRIBUTE_DATA *data)
242 WIN32_FIND_DATA find_data;
246 res = GetFileAttributesEx (path, GetFileExInfoStandard, data);
250 error = GetLastError ();
252 if (error != ERROR_SHARING_VIOLATION)
255 find_handle = FindFirstFile (path, &find_data);
257 if (find_handle == INVALID_HANDLE_VALUE)
260 FindClose (find_handle);
262 data->dwFileAttributes = find_data.dwFileAttributes;
263 data->ftCreationTime = find_data.ftCreationTime;
264 data->ftLastAccessTime = find_data.ftLastAccessTime;
265 data->ftLastWriteTime = find_data.ftLastWriteTime;
266 data->nFileSizeHigh = find_data.nFileSizeHigh;
267 data->nFileSizeLow = find_data.nFileSizeLow;
272 /* System.IO.MonoIO internal calls */
275 ves_icall_System_IO_MonoIO_CreateDirectory (MonoString *path, gint32 *error)
281 *error=ERROR_SUCCESS;
283 ret=CreateDirectory (mono_string_chars (path), NULL);
285 *error=GetLastError ();
292 ves_icall_System_IO_MonoIO_RemoveDirectory (MonoString *path, gint32 *error)
298 *error=ERROR_SUCCESS;
300 ret=RemoveDirectory (mono_string_chars (path));
302 *error=GetLastError ();
309 ves_icall_System_IO_MonoIO_GetFileSystemEntries (MonoString *path,
310 MonoString *path_with_pattern,
311 gint attrs, gint mask,
317 WIN32_FIND_DATA data;
320 gchar *utf8_path, *utf8_result, *full_name;
324 *error = ERROR_SUCCESS;
326 domain = mono_domain_get ();
327 mask = convert_attrs (mask);
329 find_handle = FindFirstFile (mono_string_chars (path_with_pattern),
331 if (find_handle == INVALID_HANDLE_VALUE) {
332 gint32 find_error = GetLastError ();
334 if (find_error == ERROR_FILE_NOT_FOUND) {
335 /* No files, so just return an empty array */
336 result = mono_array_new (domain,
337 mono_defaults.string_class,
347 utf8_path = mono_string_to_utf8 (path); /*If this raises there is not memory to release*/
348 names = g_ptr_array_new ();
351 if ((data.cFileName[0] == '.' && data.cFileName[1] == 0) ||
352 (data.cFileName[0] == '.' && data.cFileName[1] == '.' && data.cFileName[2] == 0)) {
356 if ((data.dwFileAttributes & mask) == attrs) {
357 utf8_result = g_utf16_to_utf8 (data.cFileName, -1, NULL, NULL, NULL);
358 if (utf8_result == NULL) {
362 full_name = g_build_filename (utf8_path, utf8_result, NULL);
363 g_ptr_array_add (names, full_name);
365 g_free (utf8_result);
367 } while(FindNextFile (find_handle, &data));
369 if (FindClose (find_handle) == FALSE) {
370 *error = GetLastError ();
373 result = mono_array_new (domain, mono_defaults.string_class, names->len);
374 for (i = 0; i < names->len; i++) {
375 mono_array_setref (result, i, mono_string_new (domain, g_ptr_array_index (names, i)));
379 for (i = 0; i < names->len; i++) {
380 g_free (g_ptr_array_index (names, i));
382 g_ptr_array_free (names, TRUE);
389 ves_icall_System_IO_MonoIO_GetCurrentDirectory (gint32 *error)
397 len = MAX_PATH + 1; /*FIXME this is too smal under most unix systems.*/
398 buf = g_new (gunichar2, len);
400 *error=ERROR_SUCCESS;
403 res_len = GetCurrentDirectory (len, buf);
404 if (res_len > len) { /*buf is too small.*/
405 int old_res_len = res_len;
407 buf = g_new (gunichar2, res_len);
408 res_len = GetCurrentDirectory (res_len, buf) == old_res_len;
416 result = mono_string_new_utf16 (mono_domain_get (), buf, len);
418 *error=GetLastError ();
426 ves_icall_System_IO_MonoIO_SetCurrentDirectory (MonoString *path,
433 *error=ERROR_SUCCESS;
435 ret=SetCurrentDirectory (mono_string_chars (path));
437 *error=GetLastError ();
444 ves_icall_System_IO_MonoIO_MoveFile (MonoString *path, MonoString *dest,
451 *error=ERROR_SUCCESS;
453 ret=MoveFile (mono_string_chars (path), mono_string_chars (dest));
455 *error=GetLastError ();
462 ves_icall_System_IO_MonoIO_ReplaceFile (MonoString *sourceFileName, MonoString *destinationFileName,
463 MonoString *destinationBackupFileName, MonoBoolean ignoreMetadataErrors,
467 gunichar2 *utf16_sourceFileName = NULL, *utf16_destinationFileName = NULL, *utf16_destinationBackupFileName = NULL;
468 guint32 replaceFlags = REPLACEFILE_WRITE_THROUGH;
473 utf16_sourceFileName = mono_string_chars (sourceFileName);
474 if (destinationFileName)
475 utf16_destinationFileName = mono_string_chars (destinationFileName);
476 if (destinationBackupFileName)
477 utf16_destinationBackupFileName = mono_string_chars (destinationBackupFileName);
479 *error = ERROR_SUCCESS;
480 if (ignoreMetadataErrors)
481 replaceFlags |= REPLACEFILE_IGNORE_MERGE_ERRORS;
483 ret = ReplaceFile (utf16_destinationFileName, utf16_sourceFileName, utf16_destinationBackupFileName,
484 replaceFlags, NULL, NULL);
486 *error = GetLastError ();
492 ves_icall_System_IO_MonoIO_CopyFile (MonoString *path, MonoString *dest,
493 MonoBoolean overwrite, gint32 *error)
499 *error=ERROR_SUCCESS;
501 ret=CopyFile (mono_string_chars (path), mono_string_chars (dest), !overwrite);
503 *error=GetLastError ();
510 ves_icall_System_IO_MonoIO_DeleteFile (MonoString *path, gint32 *error)
516 *error=ERROR_SUCCESS;
518 ret=DeleteFile (mono_string_chars (path));
520 *error=GetLastError ();
527 ves_icall_System_IO_MonoIO_GetFileAttributes (MonoString *path, gint32 *error)
533 *error=ERROR_SUCCESS;
535 ret=get_file_attributes (mono_string_chars (path));
538 * The definition of INVALID_FILE_ATTRIBUTES in the cygwin win32
539 * headers is wrong, hence this temporary workaround.
541 * http://cygwin.com/ml/cygwin/2003-09/msg01771.html
544 /* if(ret==INVALID_FILE_ATTRIBUTES) { */
545 *error=GetLastError ();
552 ves_icall_System_IO_MonoIO_SetFileAttributes (MonoString *path, gint32 attrs,
559 *error=ERROR_SUCCESS;
561 ret=SetFileAttributes (mono_string_chars (path),
562 convert_attrs (attrs));
564 *error=GetLastError ();
571 ves_icall_System_IO_MonoIO_GetFileType (HANDLE handle, gint32 *error)
577 *error=ERROR_SUCCESS;
579 ret=GetFileType (handle);
580 if(ret==FILE_TYPE_UNKNOWN) {
581 /* Not necessarily an error, but the caller will have
582 * to decide based on the error value.
584 *error=GetLastError ();
591 ves_icall_System_IO_MonoIO_GetFileStat (MonoString *path, MonoIOStat *stat,
595 WIN32_FILE_ATTRIBUTE_DATA data;
599 *error=ERROR_SUCCESS;
601 result = get_file_attributes_ex (mono_string_chars (path), &data);
604 convert_win32_file_attribute_data (&data,
605 mono_string_chars (path),
608 *error=GetLastError ();
615 ves_icall_System_IO_MonoIO_Open (MonoString *filename, gint32 mode,
616 gint32 access_mode, gint32 share, gint32 options,
620 int attributes, attrs;
621 gunichar2 *chars = mono_string_chars (filename);
625 *error=ERROR_SUCCESS;
628 if (options & FileOptions_Encrypted)
629 attributes = FILE_ATTRIBUTE_ENCRYPTED;
631 attributes = FILE_ATTRIBUTE_NORMAL;
632 if (options & FileOptions_DeleteOnClose)
633 attributes |= FILE_FLAG_DELETE_ON_CLOSE;
634 if (options & FileOptions_SequentialScan)
635 attributes |= FILE_FLAG_SEQUENTIAL_SCAN;
636 if (options & FileOptions_RandomAccess)
637 attributes |= FILE_FLAG_RANDOM_ACCESS;
639 if (options & FileOptions_Temporary)
640 attributes |= FILE_ATTRIBUTE_TEMPORARY;
642 /* Not sure if we should set FILE_FLAG_OVERLAPPED, how does this mix with the "Async" bool here? */
643 if (options & FileOptions_Asynchronous)
644 attributes |= FILE_FLAG_OVERLAPPED;
646 if (options & FileOptions_WriteThrough)
647 attributes |= FILE_FLAG_WRITE_THROUGH;
649 attributes = FILE_ATTRIBUTE_NORMAL;
651 /* If we're opening a directory we need to set the extra flag
653 attrs = get_file_attributes (chars);
654 if (attrs != INVALID_FILE_ATTRIBUTES) {
655 if (attrs & FILE_ATTRIBUTE_DIRECTORY) {
656 attributes |= FILE_FLAG_BACKUP_SEMANTICS;
660 ret=CreateFile (chars, convert_access (access_mode),
661 convert_share (share), NULL, convert_mode (mode),
663 if(ret==INVALID_HANDLE_VALUE) {
664 *error=GetLastError ();
671 ves_icall_System_IO_MonoIO_Close (HANDLE handle, gint32 *error)
677 *error=ERROR_SUCCESS;
679 ret=CloseHandle (handle);
681 *error=GetLastError ();
688 ves_icall_System_IO_MonoIO_Read (HANDLE handle, MonoArray *dest,
689 gint32 dest_offset, gint32 count,
698 *error=ERROR_SUCCESS;
700 if (dest_offset + count > mono_array_length (dest))
703 buffer = mono_array_addr (dest, guchar, dest_offset);
704 result = ReadFile (handle, buffer, count, &n, NULL);
707 *error=GetLastError ();
715 ves_icall_System_IO_MonoIO_Write (HANDLE handle, MonoArray *src,
716 gint32 src_offset, gint32 count,
725 *error=ERROR_SUCCESS;
727 if (src_offset + count > mono_array_length (src))
730 buffer = mono_array_addr (src, guchar, src_offset);
731 result = WriteFile (handle, buffer, count, &n, NULL);
734 *error=GetLastError ();
742 ves_icall_System_IO_MonoIO_Seek (HANDLE handle, gint64 offset, gint32 origin,
749 *error=ERROR_SUCCESS;
751 offset_hi = offset >> 32;
752 offset = SetFilePointer (handle, offset & 0xFFFFFFFF, &offset_hi,
753 convert_seekorigin (origin));
755 if(offset==INVALID_SET_FILE_POINTER) {
756 *error=GetLastError ();
759 return offset | ((gint64)offset_hi << 32);
763 ves_icall_System_IO_MonoIO_Flush (HANDLE handle, gint32 *error)
769 *error=ERROR_SUCCESS;
771 ret=FlushFileBuffers (handle);
773 *error=GetLastError ();
780 ves_icall_System_IO_MonoIO_GetLength (HANDLE handle, gint32 *error)
787 *error=ERROR_SUCCESS;
789 length = GetFileSize (handle, &length_hi);
790 if(length==INVALID_FILE_SIZE) {
791 *error=GetLastError ();
794 return length | ((gint64)length_hi << 32);
798 ves_icall_System_IO_MonoIO_SetLength (HANDLE handle, gint64 length,
801 gint64 offset, offset_set;
808 *error=ERROR_SUCCESS;
810 /* save file pointer */
813 offset = SetFilePointer (handle, 0, &offset_hi, FILE_CURRENT);
814 if(offset==INVALID_SET_FILE_POINTER) {
815 *error=GetLastError ();
819 /* extend or truncate */
821 length_hi = length >> 32;
822 offset_set=SetFilePointer (handle, length & 0xFFFFFFFF, &length_hi,
824 if(offset_set==INVALID_SET_FILE_POINTER) {
825 *error=GetLastError ();
829 result = SetEndOfFile (handle);
831 *error=GetLastError ();
835 /* restore file pointer */
837 offset_set=SetFilePointer (handle, offset & 0xFFFFFFFF, &offset_hi,
839 if(offset_set==INVALID_SET_FILE_POINTER) {
840 *error=GetLastError ();
848 ves_icall_System_IO_MonoIO_SetFileTime (HANDLE handle, gint64 creation_time,
849 gint64 last_access_time,
850 gint64 last_write_time, gint32 *error)
853 const FILETIME *creation_filetime;
854 const FILETIME *last_access_filetime;
855 const FILETIME *last_write_filetime;
859 *error=ERROR_SUCCESS;
861 if (creation_time < 0)
862 creation_filetime = NULL;
864 creation_filetime = (FILETIME *)&creation_time;
866 if (last_access_time < 0)
867 last_access_filetime = NULL;
869 last_access_filetime = (FILETIME *)&last_access_time;
871 if (last_write_time < 0)
872 last_write_filetime = NULL;
874 last_write_filetime = (FILETIME *)&last_write_time;
876 ret=SetFileTime (handle, creation_filetime, last_access_filetime, last_write_filetime);
878 *error=GetLastError ();
885 ves_icall_System_IO_MonoIO_get_ConsoleOutput ()
889 return GetStdHandle (STD_OUTPUT_HANDLE);
893 ves_icall_System_IO_MonoIO_get_ConsoleInput ()
897 return GetStdHandle (STD_INPUT_HANDLE);
901 ves_icall_System_IO_MonoIO_get_ConsoleError ()
905 return GetStdHandle (STD_ERROR_HANDLE);
909 ves_icall_System_IO_MonoIO_CreatePipe (HANDLE *read_handle,
910 HANDLE *write_handle)
912 SECURITY_ATTRIBUTES attr;
917 attr.nLength=sizeof(SECURITY_ATTRIBUTES);
918 attr.bInheritHandle=TRUE;
919 attr.lpSecurityDescriptor=NULL;
921 ret=CreatePipe (read_handle, write_handle, &attr, 0);
923 /* FIXME: throw an exception? */
930 MonoBoolean ves_icall_System_IO_MonoIO_DuplicateHandle (HANDLE source_process_handle,
931 HANDLE source_handle, HANDLE target_process_handle, HANDLE *target_handle,
932 gint32 access, gint32 inherit, gint32 options)
934 /* This is only used on Windows */
939 ret=DuplicateHandle (source_process_handle, source_handle, target_process_handle, target_handle, access, inherit, options);
941 /* FIXME: throw an exception? */
949 ves_icall_System_IO_MonoIO_get_VolumeSeparatorChar ()
951 #if defined (PLATFORM_WIN32)
952 return (gunichar2) ':'; /* colon */
954 return (gunichar2) '/'; /* forward slash */
959 ves_icall_System_IO_MonoIO_get_DirectorySeparatorChar ()
961 #if defined (PLATFORM_WIN32)
962 return (gunichar2) '\\'; /* backslash */
964 return (gunichar2) '/'; /* forward slash */
969 ves_icall_System_IO_MonoIO_get_AltDirectorySeparatorChar ()
971 #if defined (PLATFORM_WIN32)
972 return (gunichar2) '/'; /* forward slash */
974 return (gunichar2) '/'; /* slash, same as DirectorySeparatorChar */
979 ves_icall_System_IO_MonoIO_get_PathSeparator ()
981 #if defined (PLATFORM_WIN32)
982 return (gunichar2) ';'; /* semicolon */
984 return (gunichar2) ':'; /* colon */
988 static const gunichar2
989 invalid_path_chars [] = {
990 #if defined (PLATFORM_WIN32)
991 0x0022, /* double quote, which seems allowed in MS.NET but should be rejected */
992 0x003c, /* less than */
993 0x003e, /* greater than */
1010 ves_icall_System_IO_MonoIO_get_InvalidPathChars ()
1016 MONO_ARCH_SAVE_REGS;
1018 domain = mono_domain_get ();
1019 n = sizeof (invalid_path_chars) / sizeof (gunichar2);
1020 chars = mono_array_new (domain, mono_defaults.char_class, n);
1022 for (i = 0; i < n; ++ i)
1023 mono_array_set (chars, gunichar2, i, invalid_path_chars [i]);
1029 ves_icall_System_IO_MonoIO_GetTempPath (MonoString **mono_name)
1034 name=g_new0 (gunichar2, 256);
1036 ret=GetTempPath (256, name);
1038 /* Buffer was too short. Try again... */
1040 name=g_new0 (gunichar2, ret+2); /* include the terminator */
1041 ret=GetTempPath (ret, name);
1046 g_message ("%s: Temp path is [%s] (len %d)", __func__, name, ret);
1049 mono_gc_wbarrier_generic_store ((gpointer) mono_name,
1050 (MonoObject*) mono_string_new_utf16 (mono_domain_get (), name, ret));
1058 void ves_icall_System_IO_MonoIO_Lock (HANDLE handle, gint64 position,
1059 gint64 length, gint32 *error)
1063 *error=ERROR_SUCCESS;
1065 ret=LockFile (handle, position & 0xFFFFFFFF, position >> 32,
1066 length & 0xFFFFFFFF, length >> 32);
1068 *error = GetLastError ();
1072 void ves_icall_System_IO_MonoIO_Unlock (HANDLE handle, gint64 position,
1073 gint64 length, gint32 *error)
1077 *error=ERROR_SUCCESS;
1079 ret=UnlockFile (handle, position & 0xFFFFFFFF, position >> 32,
1080 length & 0xFFFFFFFF, length >> 32);
1082 *error = GetLastError ();