1 // System.IO.MonoIO.cs: static interface to native filesystem.
4 // Dan Lewis (dihlewis@yahoo.co.uk)
5 // Dick Porter (dick@ximian.com)
8 // Copyright 2011 Xamarin Inc (http://www.xamarin.com).
12 // Copyright (C) 2004 Novell, Inc (http://www.novell.com)
14 // Permission is hereby granted, free of charge, to any person obtaining
15 // a copy of this software and associated documentation files (the
16 // "Software"), to deal in the Software without restriction, including
17 // without limitation the rights to use, copy, modify, merge, publish,
18 // distribute, sublicense, and/or sell copies of the Software, and to
19 // permit persons to whom the Software is furnished to do so, subject to
20 // the following conditions:
22 // The above copyright notice and this permission notice shall be
23 // included in all copies or substantial portions of the Software.
25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 using System.Runtime.CompilerServices;
36 using System.Runtime.InteropServices;
37 using System.Threading;
38 using Microsoft.Win32.SafeHandles;
40 using System.IO.IsolatedStorage;
45 unsafe static class MonoIO {
46 public const int FileAlreadyExistsHResult = unchecked ((int) 0x80070000) | (int)MonoIOError.ERROR_FILE_EXISTS;
48 public const FileAttributes
49 InvalidFileAttributes = (FileAttributes)(-1);
51 public static readonly IntPtr
52 InvalidHandle = (IntPtr)(-1L);
54 static bool dump_handles = Environment.GetEnvironmentVariable ("MONO_DUMP_HANDLES_ON_ERROR_TOO_MANY_OPEN_FILES") != null;
57 public static Exception GetException (MonoIOError error)
59 /* This overload is currently only called from
60 * File.MoveFile(), Directory.Move() and
61 * Directory.GetCurrentDirectory() -
62 * everywhere else supplies a path to format
63 * with the error text.
66 case MonoIOError.ERROR_ACCESS_DENIED:
67 return new UnauthorizedAccessException ("Access to the path is denied.");
68 case MonoIOError.ERROR_FILE_EXISTS:
69 string message = "Cannot create a file that already exist.";
70 return new IOException (message, FileAlreadyExistsHResult);
72 /* Add more mappings here if other
73 * errors trigger the named but empty
74 * path bug (see bug 82141.) For
75 * everything else, fall through to
78 return GetException (String.Empty, error);
82 public static Exception GetException (string path,
88 // FIXME: add more exception mappings here
89 case MonoIOError.ERROR_FILE_NOT_FOUND:
90 message = String.Format ("Could not find file \"{0}\"", path);
91 return new FileNotFoundException (message, path);
93 case MonoIOError.ERROR_TOO_MANY_OPEN_FILES:
96 return new IOException ("Too many open files", unchecked((int)0x80070000) | (int)error);
98 case MonoIOError.ERROR_PATH_NOT_FOUND:
99 message = String.Format ("Could not find a part of the path \"{0}\"", path);
100 return new DirectoryNotFoundException (message);
102 case MonoIOError.ERROR_ACCESS_DENIED:
103 message = String.Format ("Access to the path \"{0}\" is denied.", path);
104 return new UnauthorizedAccessException (message);
106 case MonoIOError.ERROR_INVALID_HANDLE:
107 message = String.Format ("Invalid handle to path \"{0}\"", path);
108 return new IOException (message, unchecked((int)0x80070000) | (int)error);
109 case MonoIOError.ERROR_INVALID_DRIVE:
110 message = String.Format ("Could not find the drive '{0}'. The drive might not be ready or might not be mapped.", path);
112 return new DriveNotFoundException (message);
114 return new IOException (message, unchecked((int)0x80070000) | (int)error);
116 case MonoIOError.ERROR_FILE_EXISTS:
117 message = String.Format ("Could not create file \"{0}\". File already exists.", path);
118 return new IOException (message, unchecked((int)0x80070000) | (int)error);
120 case MonoIOError.ERROR_FILENAME_EXCED_RANGE:
121 message = String.Format ("Path is too long. Path: {0}", path);
122 return new PathTooLongException (message);
124 case MonoIOError.ERROR_INVALID_PARAMETER:
125 message = String.Format ("Invalid parameter");
126 return new IOException (message, unchecked((int)0x80070000) | (int)error);
128 case MonoIOError.ERROR_WRITE_FAULT:
129 message = String.Format ("Write fault on path {0}", path);
130 return new IOException (message, unchecked((int)0x80070000) | (int)error);
132 case MonoIOError.ERROR_SHARING_VIOLATION:
133 message = String.Format ("Sharing violation on path {0}", path);
134 return new IOException (message, unchecked((int)0x80070000) | (int)error);
136 case MonoIOError.ERROR_LOCK_VIOLATION:
137 message = String.Format ("Lock violation on path {0}", path);
138 return new IOException (message, unchecked((int)0x80070000) | (int)error);
140 case MonoIOError.ERROR_HANDLE_DISK_FULL:
141 message = String.Format ("Disk full. Path {0}", path);
142 return new IOException (message, unchecked((int)0x80070000) | (int)error);
144 case MonoIOError.ERROR_DIR_NOT_EMPTY:
145 message = String.Format ("Directory {0} is not empty", path);
146 return new IOException (message, unchecked((int)0x80070000) | (int)error);
148 case MonoIOError.ERROR_ENCRYPTION_FAILED:
149 return new IOException ("Encryption failed", unchecked((int)0x80070000) | (int)error);
151 case MonoIOError.ERROR_CANNOT_MAKE:
152 message = String.Format ("Path {0} is a directory", path);
153 return new IOException (message, unchecked((int)0x80070000) | (int)error);
155 case MonoIOError.ERROR_NOT_SAME_DEVICE:
156 message = "Source and destination are not on the same device";
157 return new IOException (message, unchecked((int)0x80070000) | (int)error);
159 case MonoIOError.ERROR_DIRECTORY:
160 message = "The directory name is invalid";
161 return new IOException (message, unchecked((int)0x80070000) | (int)error);
164 message = String.Format ("Win32 IO returned {0}. Path: {1}", error, path);
165 return new IOException (message, unchecked((int)0x80070000) | (int)error);
171 [MethodImplAttribute (MethodImplOptions.InternalCall)]
172 public extern static bool CreateDirectory (string path, out MonoIOError error);
174 [MethodImplAttribute (MethodImplOptions.InternalCall)]
175 public extern static bool RemoveDirectory (string path, out MonoIOError error);
177 [MethodImplAttribute (MethodImplOptions.InternalCall)]
178 public extern static string [] GetFileSystemEntries (string path, string path_with_pattern, int attrs, int mask, out MonoIOError error);
180 [MethodImplAttribute (MethodImplOptions.InternalCall)]
181 public extern static string GetCurrentDirectory (out MonoIOError error);
183 [MethodImplAttribute (MethodImplOptions.InternalCall)]
184 public extern static bool SetCurrentDirectory (string path, out MonoIOError error);
188 [MethodImplAttribute (MethodImplOptions.InternalCall)]
189 public extern static bool MoveFile (string path, string dest,
190 out MonoIOError error);
192 [MethodImplAttribute (MethodImplOptions.InternalCall)]
193 public extern static bool CopyFile (string path, string dest,
195 out MonoIOError error);
197 [MethodImplAttribute (MethodImplOptions.InternalCall)]
198 public extern static bool DeleteFile (string path,
199 out MonoIOError error);
201 [MethodImplAttribute (MethodImplOptions.InternalCall)]
202 public extern static bool ReplaceFile (string sourceFileName,
203 string destinationFileName,
204 string destinationBackupFileName,
205 bool ignoreMetadataErrors,
206 out MonoIOError error);
208 [MethodImplAttribute (MethodImplOptions.InternalCall)]
209 public extern static FileAttributes GetFileAttributes (string path, out MonoIOError error);
211 [MethodImplAttribute (MethodImplOptions.InternalCall)]
212 public extern static bool SetFileAttributes (string path, FileAttributes attrs, out MonoIOError error);
214 [MethodImplAttribute (MethodImplOptions.InternalCall)]
215 private extern static MonoFileType GetFileType (IntPtr handle, out MonoIOError error);
217 public static MonoFileType GetFileType (SafeHandle safeHandle, out MonoIOError error)
219 bool release = false;
221 safeHandle.DangerousAddRef (ref release);
222 return GetFileType (safeHandle.DangerousGetHandle (), out error);
225 safeHandle.DangerousRelease ();
232 [MethodImplAttribute (MethodImplOptions.InternalCall)]
233 public extern static string FindFirst (string path, string pattern, out FileAttributes result_attr, out MonoIOError error, out IntPtr handle);
235 [MethodImplAttribute (MethodImplOptions.InternalCall)]
236 public extern static string FindNext (IntPtr handle, out FileAttributes result_attr, out MonoIOError error);
238 [MethodImplAttribute (MethodImplOptions.InternalCall)]
239 public extern static int FindClose (IntPtr handle);
241 public static bool Exists (string path, out MonoIOError error)
243 FileAttributes attrs = GetFileAttributes (path,
245 if (attrs == InvalidFileAttributes)
251 public static bool ExistsFile (string path,
252 out MonoIOError error)
254 FileAttributes attrs = GetFileAttributes (path,
256 if (attrs == InvalidFileAttributes)
259 if ((attrs & FileAttributes.Directory) != 0)
265 public static bool ExistsDirectory (string path,
266 out MonoIOError error)
268 FileAttributes attrs = GetFileAttributes (path,
271 // Actually, we are looking for a directory, not a file
272 if (error == MonoIOError.ERROR_FILE_NOT_FOUND)
273 error = MonoIOError.ERROR_PATH_NOT_FOUND;
275 if (attrs == InvalidFileAttributes)
278 if ((attrs & FileAttributes.Directory) == 0)
284 public static bool ExistsSymlink (string path,
285 out MonoIOError error)
287 FileAttributes attrs = GetFileAttributes (path,
289 if (attrs == InvalidFileAttributes)
292 if ((attrs & FileAttributes.ReparsePoint) == 0)
298 [MethodImplAttribute (MethodImplOptions.InternalCall)]
299 public extern static bool GetFileStat (string path,
301 out MonoIOError error);
305 [MethodImplAttribute (MethodImplOptions.InternalCall)]
306 public extern static IntPtr Open (string filename,
311 out MonoIOError error);
313 [MethodImplAttribute (MethodImplOptions.InternalCall)]
314 public extern static bool Close (IntPtr handle,
315 out MonoIOError error);
317 [MethodImplAttribute (MethodImplOptions.InternalCall)]
318 private extern static int Read (IntPtr handle, byte [] dest,
319 int dest_offset, int count,
320 out MonoIOError error);
322 public static int Read (SafeHandle safeHandle, byte [] dest,
323 int dest_offset, int count,
324 out MonoIOError error)
326 bool release = false;
328 safeHandle.DangerousAddRef (ref release);
329 return Read (safeHandle.DangerousGetHandle (), dest, dest_offset, count, out error);
332 safeHandle.DangerousRelease ();
336 [MethodImplAttribute (MethodImplOptions.InternalCall)]
337 private extern static int Write (IntPtr handle, [In] byte [] src,
338 int src_offset, int count,
339 out MonoIOError error);
341 public static int Write (SafeHandle safeHandle, byte [] src,
342 int src_offset, int count,
343 out MonoIOError error)
345 bool release = false;
347 safeHandle.DangerousAddRef (ref release);
348 return Write (safeHandle.DangerousGetHandle (), src, src_offset, count, out error);
351 safeHandle.DangerousRelease ();
355 [MethodImplAttribute (MethodImplOptions.InternalCall)]
356 private extern static long Seek (IntPtr handle, long offset,
358 out MonoIOError error);
360 public static long Seek (SafeHandle safeHandle, long offset,
362 out MonoIOError error)
364 bool release = false;
366 safeHandle.DangerousAddRef (ref release);
367 return Seek (safeHandle.DangerousGetHandle (), offset, origin, out error);
370 safeHandle.DangerousRelease ();
374 [MethodImplAttribute (MethodImplOptions.InternalCall)]
375 private extern static bool Flush (IntPtr handle,
376 out MonoIOError error);
378 public static bool Flush (SafeHandle safeHandle,
379 out MonoIOError error)
381 bool release = false;
383 safeHandle.DangerousAddRef (ref release);
384 return Flush (safeHandle.DangerousGetHandle (), out error);
387 safeHandle.DangerousRelease ();
391 [MethodImplAttribute (MethodImplOptions.InternalCall)]
392 private extern static long GetLength (IntPtr handle,
393 out MonoIOError error);
395 public static long GetLength (SafeHandle safeHandle,
396 out MonoIOError error)
398 bool release = false;
400 safeHandle.DangerousAddRef (ref release);
401 return GetLength (safeHandle.DangerousGetHandle (), out error);
404 safeHandle.DangerousRelease ();
408 [MethodImplAttribute (MethodImplOptions.InternalCall)]
409 private extern static bool SetLength (IntPtr handle,
411 out MonoIOError error);
413 public static bool SetLength (SafeHandle safeHandle,
415 out MonoIOError error)
417 bool release = false;
419 safeHandle.DangerousAddRef (ref release);
420 return SetLength (safeHandle.DangerousGetHandle (), length, out error);
423 safeHandle.DangerousRelease ();
427 [MethodImplAttribute (MethodImplOptions.InternalCall)]
428 private extern static bool SetFileTime (IntPtr handle,
430 long last_access_time,
431 long last_write_time,
432 out MonoIOError error);
434 public static bool SetFileTime (SafeHandle safeHandle,
436 long last_access_time,
437 long last_write_time,
438 out MonoIOError error)
440 bool release = false;
442 safeHandle.DangerousAddRef (ref release);
443 return SetFileTime (safeHandle.DangerousGetHandle (), creation_time, last_access_time, last_write_time, out error);
446 safeHandle.DangerousRelease ();
450 public static bool SetFileTime (string path,
452 long last_access_time,
453 long last_write_time,
454 out MonoIOError error)
456 return SetFileTime (path,
465 public static bool SetCreationTime (string path,
467 out MonoIOError error)
469 return SetFileTime (path, 1, -1, -1, -1, dateTime, out error);
472 public static bool SetLastAccessTime (string path,
474 out MonoIOError error)
476 return SetFileTime (path, 2, -1, -1, -1, dateTime, out error);
479 public static bool SetLastWriteTime (string path,
481 out MonoIOError error)
483 return SetFileTime (path, 3, -1, -1, -1, dateTime, out error);
486 public static bool SetFileTime (string path,
489 long last_access_time,
490 long last_write_time,
492 out MonoIOError error)
497 handle = Open (path, FileMode.Open,
498 FileAccess.ReadWrite,
499 FileShare.ReadWrite, FileOptions.None, out error);
500 if (handle == MonoIO.InvalidHandle)
505 creation_time = dateTime.ToFileTime ();
508 last_access_time = dateTime.ToFileTime ();
511 last_write_time = dateTime.ToFileTime ();
515 result = SetFileTime (new SafeFileHandle(handle, false), creation_time,
517 last_write_time, out error);
519 MonoIOError ignore_error;
520 Close (handle, out ignore_error);
525 [MethodImplAttribute (MethodImplOptions.InternalCall)]
526 private extern static void Lock (IntPtr handle,
527 long position, long length,
528 out MonoIOError error);
530 public static void Lock (SafeHandle safeHandle,
531 long position, long length,
532 out MonoIOError error)
534 bool release = false;
536 safeHandle.DangerousAddRef (ref release);
537 Lock (safeHandle.DangerousGetHandle (), position, length, out error);
540 safeHandle.DangerousRelease ();
544 [MethodImplAttribute (MethodImplOptions.InternalCall)]
545 private extern static void Unlock (IntPtr handle,
546 long position, long length,
547 out MonoIOError error);
549 public static void Unlock (SafeHandle safeHandle,
550 long position, long length,
551 out MonoIOError error)
553 bool release = false;
555 safeHandle.DangerousAddRef (ref release);
556 Unlock (safeHandle.DangerousGetHandle (), position, length, out error);
559 safeHandle.DangerousRelease ();
565 public extern static IntPtr ConsoleOutput {
566 [MethodImplAttribute (MethodImplOptions.InternalCall)]
570 public extern static IntPtr ConsoleInput {
571 [MethodImplAttribute (MethodImplOptions.InternalCall)]
575 public extern static IntPtr ConsoleError {
576 [MethodImplAttribute (MethodImplOptions.InternalCall)]
582 [MethodImplAttribute (MethodImplOptions.InternalCall)]
583 public extern static bool CreatePipe (out IntPtr read_handle, out IntPtr write_handle, out MonoIOError error);
585 [MethodImplAttribute (MethodImplOptions.InternalCall)]
586 public extern static bool DuplicateHandle (IntPtr source_process_handle, IntPtr source_handle,
587 IntPtr target_process_handle, out IntPtr target_handle, int access, int inherit, int options, out MonoIOError error);
591 public extern static char VolumeSeparatorChar {
592 [MethodImplAttribute (MethodImplOptions.InternalCall)]
596 public extern static char DirectorySeparatorChar {
597 [MethodImplAttribute (MethodImplOptions.InternalCall)]
601 public extern static char AltDirectorySeparatorChar {
602 [MethodImplAttribute (MethodImplOptions.InternalCall)]
606 public extern static char PathSeparator {
607 [MethodImplAttribute (MethodImplOptions.InternalCall)]
611 [MethodImplAttribute (MethodImplOptions.InternalCall)]
612 extern static void DumpHandles ();