mono/metadata/w32file.h

   1 /**
   2  * \file
   3  * File IO internal calls
   4  *
   5  * Authors:
   6  *      Dick Porter (dick@ximian.com)
   7  *      Dan Lewis (dihlewis@yahoo.co.uk)
   8  *
   9  * (C) 2001 Ximian, Inc.
  10  * Copyright 2012 Xamarin Inc (http://www.xamarin.com)
  11  * Licensed under the MIT license. See LICENSE file in the project root for full license information.
  12  */
  13
  14 #ifndef _MONO_METADATA_W32FILE_H_
  15 #define _MONO_METADATA_W32FILE_H_
  16
  17 #include <config.h>
  18 #include <glib.h>
  19
  20 #include <mono/metadata/object-internals.h>
  21 #include <mono/utils/mono-compiler.h>
  22
  23 G_BEGIN_DECLS
  24
  25 /* This is a copy of System.IO.FileAccess */
  26 typedef enum {
  27         FileAccess_Read=0x01,
  28         FileAccess_Write=0x02,
  29         FileAccess_ReadWrite=FileAccess_Read|FileAccess_Write
  30 } MonoFileAccess;
  31
  32 /* This is a copy of System.IO.FileMode */
  33 typedef enum {
  34         FileMode_CreateNew=1,
  35         FileMode_Create=2,
  36         FileMode_Open=3,
  37         FileMode_OpenOrCreate=4,
  38         FileMode_Truncate=5,
  39         FileMode_Append=6
  40 } MonoFileMode;
  41
  42 /* This is a copy of System.IO.FileShare */
  43 typedef enum {
  44         FileShare_None=0x0,
  45         FileShare_Read=0x01,
  46         FileShare_Write=0x02,
  47         FileShare_ReadWrite=FileShare_Read|FileShare_Write,
  48         FileShare_Delete=0x04
  49 } MonoFileShare;
  50
  51 /* This is a copy of System.IO.FileOptions */
  52 typedef enum {
  53         FileOptions_None = 0,
  54         FileOptions_Temporary = 1,              // Internal.   See note in System.IO.FileOptions
  55         FileOptions_Encrypted = 0x4000,
  56         FileOptions_DeleteOnClose = 0x4000000,
  57         FileOptions_SequentialScan = 0x8000000,
  58         FileOptions_RandomAccess = 0x10000000,
  59         FileOptions_Asynchronous = 0x40000000,
  60         FileOptions_WriteThrough = 0x80000000
  61 } MonoFileOptions;
  62
  63 /* This is a copy of System.IO.SeekOrigin */
  64 typedef enum {
  65         SeekOrigin_Begin=0,
  66         SeekOrigin_Current=1,
  67         SeekOrigin_End=2
  68 } MonoSeekOrigin;
  69
  70 /* This is a copy of System.IO.MonoIOStat */
  71 typedef struct _MonoIOStat {
  72         gint32 attributes;
  73         gint64 length;
  74         gint64 creation_time;
  75         gint64 last_access_time;
  76         gint64 last_write_time;
  77 } MonoIOStat;
  78
  79 /* This is a copy of System.IO.FileAttributes */
  80 typedef enum {
  81         FileAttributes_ReadOnly=0x00001,
  82         FileAttributes_Hidden=0x00002,
  83         FileAttributes_System=0x00004,
  84         FileAttributes_Directory=0x00010,
  85         FileAttributes_Archive=0x00020,
  86         FileAttributes_Device=0x00040,
  87         FileAttributes_Normal=0x00080,
  88         FileAttributes_Temporary=0x00100,
  89         FileAttributes_SparseFile=0x00200,
  90         FileAttributes_ReparsePoint=0x00400,
  91         FileAttributes_Compressed=0x00800,
  92         FileAttributes_Offline=0x01000,
  93         FileAttributes_NotContentIndexed=0x02000,
  94         FileAttributes_Encrypted=0x04000,
  95         FileAttributes_MonoExecutable= (int) 0x80000000
  96 } MonoFileAttributes;
  97 /* This is not used anymore
  98 typedef struct _MonoFSAsyncResult {
  99         MonoObject obj;
 100         MonoObject *state;
 101         MonoBoolean completed;
 102         MonoBoolean done;
 103         MonoException *exc;
 104         MonoWaitHandle *wait_handle;
 105         MonoDelegate *async_callback;
 106         MonoBoolean completed_synch;
 107         MonoArray *buffer;
 108         gint offset;
 109         gint count;
 110         gint original_count;
 111         gint bytes_read;
 112         MonoDelegate *real_cb;
 113 } MonoFSAsyncResult;
 114 */
 115 /* System.IO.MonoIO */
 116
 117 extern MonoBoolean
 118 ves_icall_System_IO_MonoIO_CreateDirectory (MonoString *path, gint32 *error);
 119
 120 extern MonoBoolean
 121 ves_icall_System_IO_MonoIO_RemoveDirectory (MonoString *path, gint32 *error);
 122
 123 extern gpointer
 124 ves_icall_System_IO_MonoIO_FindFirstFile (MonoString *path_with_pattern,
 125                                                 MonoString **file_name,
 126                                                 gint32 *file_attr,
 127                                                 gint32 *ioerror);
 128
 129 extern MonoBoolean
 130 ves_icall_System_IO_MonoIO_FindNextFile (gpointer hnd,
 131                                                 MonoString **file_name,
 132                                                 gint32 *file_attr,
 133                                                 gint32 *ioerror);
 134
 135 extern MonoBoolean
 136 ves_icall_System_IO_MonoIO_FindCloseFile (gpointer hnd);
 137
 138 extern MonoString *
 139 ves_icall_System_IO_MonoIO_FindFirst (MonoString *path,
 140                                       MonoString *path_with_pattern,
 141                                       gint32 *result_mask,
 142                                       gint32 *error,
 143                                       gpointer *handle);
 144 extern MonoString *
 145 ves_icall_System_IO_MonoIO_FindNext (gpointer handle, gint32 *result_mask, gint32 *error);
 146
 147 extern int
 148 ves_icall_System_IO_MonoIO_FindClose (gpointer handle);
 149
 150 extern MonoString *
 151 ves_icall_System_IO_MonoIO_GetCurrentDirectory (gint32 *error);
 152
 153 extern MonoBoolean
 154 ves_icall_System_IO_MonoIO_SetCurrentDirectory (MonoString *path,
 155                                                 gint32 *error);
 156
 157 extern MonoBoolean
 158 ves_icall_System_IO_MonoIO_MoveFile (MonoString *path, MonoString *dest,
 159                                      gint32 *error);
 160
 161 extern MonoBoolean
 162 ves_icall_System_IO_MonoIO_CopyFile (MonoString *path, MonoString *dest,
 163                                      MonoBoolean overwrite, gint32 *error);
 164
 165 extern MonoBoolean
 166 ves_icall_System_IO_MonoIO_DeleteFile (MonoString *path, gint32 *error);
 167
 168 extern gint32
 169 ves_icall_System_IO_MonoIO_GetFileAttributes (MonoString *path, gint32 *error);
 170
 171 extern MonoBoolean
 172 ves_icall_System_IO_MonoIO_SetFileAttributes (MonoString *path, gint32 attrs,
 173                                               gint32 *error);
 174
 175 extern gint32
 176 ves_icall_System_IO_MonoIO_GetFileType (gpointer handle, gint32 *error);
 177
 178 extern MonoBoolean
 179 ves_icall_System_IO_MonoIO_GetFileStat (MonoString *path, MonoIOStat *stat,
 180                                         gint32 *error);
 181
 182 extern gpointer
 183 ves_icall_System_IO_MonoIO_Open (MonoString *filename, gint32 mode,
 184                                  gint32 access_mode, gint32 share, gint32 options,
 185                                  gint32 *error);
 186
 187 extern MonoBoolean
 188 ves_icall_System_IO_MonoIO_Close (gpointer handle, gint32 *error);
 189
 190 extern gint32
 191 ves_icall_System_IO_MonoIO_Read (gpointer handle, MonoArray *dest,
 192                                  gint32 dest_offset, gint32 count,
 193                                  gint32 *error);
 194
 195 extern gint32
 196 ves_icall_System_IO_MonoIO_Write (gpointer handle, MonoArray *src,
 197                                   gint32 src_offset, gint32 count,
 198                                   gint32 *error);
 199
 200 extern gint64
 201 ves_icall_System_IO_MonoIO_Seek (gpointer handle, gint64 offset, gint32 origin,
 202                                  gint32 *error);
 203
 204 extern MonoBoolean
 205 ves_icall_System_IO_MonoIO_Flush (gpointer handle, gint32 *error);
 206
 207 extern gint64
 208 ves_icall_System_IO_MonoIO_GetLength (gpointer handle, gint32 *error);
 209
 210 extern MonoBoolean
 211 ves_icall_System_IO_MonoIO_SetLength (gpointer handle, gint64 length,
 212                                       gint32 *error);
 213
 214 extern MonoBoolean
 215 ves_icall_System_IO_MonoIO_SetFileTime (gpointer handle, gint64 creation_time,
 216                                         gint64 last_access_time,
 217                                         gint64 last_write_time, gint32 *error);
 218
 219 extern gpointer
 220 ves_icall_System_IO_MonoIO_get_ConsoleOutput (void);
 221
 222 extern gpointer
 223 ves_icall_System_IO_MonoIO_get_ConsoleInput (void);
 224
 225 extern gpointer
 226 ves_icall_System_IO_MonoIO_get_ConsoleError (void);
 227
 228 extern MonoBoolean
 229 ves_icall_System_IO_MonoIO_CreatePipe (gpointer *read_handle, gpointer *write_handle, gint32 *error);
 230
 231 extern MonoBoolean
 232 ves_icall_System_IO_MonoIO_DuplicateHandle (gpointer source_process_handle, gpointer source_handle,
 233                 gpointer target_process_handle, gpointer *target_handle, gint32 access, gint32 inherit, gint32 options, gint32 *error);
 234
 235 extern gunichar2
 236 ves_icall_System_IO_MonoIO_get_VolumeSeparatorChar (void);
 237
 238 extern gunichar2
 239 ves_icall_System_IO_MonoIO_get_DirectorySeparatorChar (void);
 240
 241 extern gunichar2
 242 ves_icall_System_IO_MonoIO_get_AltDirectorySeparatorChar (void);
 243
 244 extern gunichar2
 245 ves_icall_System_IO_MonoIO_get_PathSeparator (void);
 246
 247 extern MonoArray *
 248 ves_icall_System_IO_MonoIO_get_InvalidPathChars (void);
 249
 250 extern void ves_icall_System_IO_MonoIO_Lock (gpointer handle, gint64 position,
 251                                              gint64 length, gint32 *error);
 252 extern void ves_icall_System_IO_MonoIO_Unlock (gpointer handle, gint64 position,
 253                                                gint64 length, gint32 *error);
 254
 255 extern MonoBoolean
 256 ves_icall_System_IO_MonoIO_ReplaceFile (MonoString *sourceFileName, MonoString *destinationFileName,
 257                                         MonoString *destinationBackupFileName, MonoBoolean ignoreMetadataErrors,
 258                                         gint32 *error);
 259
 260 #if defined (TARGET_IOS) || defined (TARGET_ANDROID)
 261
 262 MONO_RT_EXTERNAL_ONLY
 263 extern gint64
 264 mono_filesize_from_path (MonoString *path);
 265
 266 extern gint64
 267 mono_filesize_from_fd (int fd);
 268
 269 #endif
 270
 271 void
 272 ves_icall_System_IO_MonoIO_DumpHandles (void);
 273
 274 #if !defined(HOST_WIN32)
 275
 276 #define GENERIC_READ    0x80000000
 277 #define GENERIC_WRITE   0x40000000
 278 #define GENERIC_EXECUTE 0x20000000
 279 #define GENERIC_ALL     0x10000000
 280
 281 #define FILE_SHARE_READ   0x00000001
 282 #define FILE_SHARE_WRITE  0x00000002
 283 #define FILE_SHARE_DELETE 0x00000004
 284
 285 #define CREATE_NEW        1
 286 #define CREATE_ALWAYS     2
 287 #define OPEN_EXISTING     3
 288 #define OPEN_ALWAYS       4
 289 #define TRUNCATE_EXISTING 5
 290
 291 #define FILE_ATTRIBUTE_READONLY            0x00000001
 292 #define FILE_ATTRIBUTE_HIDDEN              0x00000002
 293 #define FILE_ATTRIBUTE_SYSTEM              0x00000004
 294 #define FILE_ATTRIBUTE_DIRECTORY           0x00000010
 295 #define FILE_ATTRIBUTE_ARCHIVE             0x00000020
 296 #define FILE_ATTRIBUTE_ENCRYPTED           0x00000040
 297 #define FILE_ATTRIBUTE_NORMAL              0x00000080
 298 #define FILE_ATTRIBUTE_TEMPORARY           0x00000100
 299 #define FILE_ATTRIBUTE_SPARSE_FILE         0x00000200
 300 #define FILE_ATTRIBUTE_REPARSE_POINT       0x00000400
 301 #define FILE_ATTRIBUTE_COMPRESSED          0x00000800
 302 #define FILE_ATTRIBUTE_OFFLINE             0x00001000
 303 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
 304 #define FILE_FLAG_OPEN_NO_RECALL           0x00100000
 305 #define FILE_FLAG_OPEN_REPARSE_POINT       0x00200000
 306 #define FILE_FLAG_POSIX_SEMANTICS          0x01000000
 307 #define FILE_FLAG_BACKUP_SEMANTICS         0x02000000
 308 #define FILE_FLAG_DELETE_ON_CLOSE          0x04000000
 309 #define FILE_FLAG_SEQUENTIAL_SCAN          0x08000000
 310 #define FILE_FLAG_RANDOM_ACCESS            0x10000000
 311 #define FILE_FLAG_NO_BUFFERING             0x20000000
 312 #define FILE_FLAG_OVERLAPPED               0x40000000
 313 #define FILE_FLAG_WRITE_THROUGH            0x80000000
 314
 315 #define REPLACEFILE_WRITE_THROUGH       0x00000001
 316 #define REPLACEFILE_IGNORE_MERGE_ERRORS 0x00000002
 317
 318 #define MAX_PATH 260
 319
 320 #define INVALID_SET_FILE_POINTER ((guint32) 0xFFFFFFFF)
 321 #define INVALID_FILE_SIZE        ((guint32) 0xFFFFFFFF)
 322 #define INVALID_FILE_ATTRIBUTES  ((guint32) 0xFFFFFFFF)
 323
 324 #define FILE_TYPE_UNKNOWN 0x0000
 325 #define FILE_TYPE_DISK    0x0001
 326 #define FILE_TYPE_CHAR    0x0002
 327 #define FILE_TYPE_PIPE    0x0003
 328 #define FILE_TYPE_REMOTE  0x8000
 329
 330 #define FILE_BEGIN   0
 331 #define FILE_CURRENT 1
 332 #define FILE_END     2
 333
 334 #define DRIVE_UNKNOWN     0
 335 #define DRIVE_NO_ROOT_DIR 1
 336 #define DRIVE_REMOVABLE   2
 337 #define DRIVE_FIXED       3
 338 #define DRIVE_REMOTE      4
 339 #define DRIVE_CDROM       5
 340 #define DRIVE_RAMDISK     6
 341
 342 typedef struct {
 343         guint16 wYear;
 344         guint16 wMonth;
 345         guint16 wDayOfWeek;
 346         guint16 wDay;
 347         guint16 wHour;
 348         guint16 wMinute;
 349         guint16 wSecond;
 350         guint16 wMilliseconds;
 351 } SYSTEMTIME;
 352
 353 typedef struct {
 354 #if G_BYTE_ORDER == G_BIG_ENDIAN
 355         guint32 dwHighDateTime;
 356         guint32 dwLowDateTime;
 357 #else
 358         guint32 dwLowDateTime;
 359         guint32 dwHighDateTime;
 360 #endif
 361 } FILETIME;
 362
 363 typedef struct {
 364         guint32 dwFileAttributes;
 365         FILETIME ftCreationTime;
 366         FILETIME ftLastAccessTime;
 367         FILETIME ftLastWriteTime;
 368         guint32 nFileSizeHigh;
 369         guint32 nFileSizeLow;
 370         guint32 dwReserved0;
 371         guint32 dwReserved1;
 372         gunichar2 cFileName [MAX_PATH];
 373         gunichar2 cAlternateFileName [14];
 374 } WIN32_FIND_DATA;
 375
 376 #endif /* !defined(HOST_WIN32) */
 377
 378 void
 379 mono_w32file_init (void);
 380
 381 void
 382 mono_w32file_cleanup (void);
 383
 384 gpointer
 385 mono_w32file_create(const gunichar2 *name, guint32 fileaccess, guint32 sharemode, guint32 createmode, guint32 attrs);
 386
 387 gboolean
 388 mono_w32file_close (gpointer handle);
 389
 390 gboolean
 391 mono_w32file_delete (const gunichar2 *name);
 392
 393 gboolean
 394 mono_w32file_read (gpointer handle, gpointer buffer, guint32 numbytes, guint32 *bytesread);
 395
 396 gboolean
 397 mono_w32file_write (gpointer handle, gconstpointer buffer, guint32 numbytes, guint32 *byteswritten);
 398
 399 gboolean
 400 mono_w32file_flush (gpointer handle);
 401
 402 gboolean
 403 mono_w32file_truncate (gpointer handle);
 404
 405 guint32
 406 mono_w32file_seek (gpointer handle, gint32 movedistance, gint32 *highmovedistance, guint32 method);
 407
 408 gboolean
 409 mono_w32file_move (gunichar2 *path, gunichar2 *dest, gint32 *error);
 410
 411 gboolean
 412 mono_w32file_copy (gunichar2 *path, gunichar2 *dest, gboolean overwrite, gint32 *error);
 413
 414 gboolean
 415 mono_w32file_lock (gpointer handle, gint64 position, gint64 length, gint32 *error);
 416
 417 gboolean
 418 mono_w32file_replace (gunichar2 *destinationFileName, gunichar2 *sourceFileName, gunichar2 *destinationBackupFileName, guint32 flags, gint32 *error);
 419
 420 gboolean
 421 mono_w32file_unlock (gpointer handle, gint64 position, gint64 length, gint32 *error);
 422
 423 gpointer
 424 mono_w32file_get_console_output (void);
 425
 426 gpointer
 427 mono_w32file_get_console_error (void);
 428
 429 gpointer
 430 mono_w32file_get_console_input (void);
 431
 432 gint64
 433 mono_w32file_get_file_size (gpointer handle, gint32 *error);
 434
 435 gint
 436 mono_w32file_get_type (gpointer handle);
 437
 438 gboolean
 439 mono_w32file_get_times (gpointer handle, FILETIME *create_time, FILETIME *access_time, FILETIME *write_time);
 440
 441 gboolean
 442 mono_w32file_set_times (gpointer handle, const FILETIME *create_time, const FILETIME *access_time, const FILETIME *write_time);
 443
 444 gboolean
 445 mono_w32file_filetime_to_systemtime (const FILETIME *file_time, SYSTEMTIME *system_time);
 446
 447 gpointer
 448 mono_w32file_find_first (const gunichar2 *pattern, WIN32_FIND_DATA *find_data);
 449
 450 gboolean
 451 mono_w32file_find_next (gpointer handle, WIN32_FIND_DATA *find_data);
 452
 453 gboolean
 454 mono_w32file_find_close (gpointer handle);
 455
 456 gboolean
 457 mono_w32file_create_directory (const gunichar2 *name);
 458
 459 gboolean
 460 mono_w32file_remove_directory (const gunichar2 *name);
 461
 462 guint32
 463 mono_w32file_get_attributes (const gunichar2 *name);
 464
 465 gboolean
 466 mono_w32file_get_attributes_ex (const gunichar2 *name, MonoIOStat *stat);
 467
 468 gboolean
 469 mono_w32file_set_attributes (const gunichar2 *name, guint32 attrs);
 470
 471 guint32
 472 mono_w32file_get_cwd (guint32 length, gunichar2 *buffer);
 473
 474 gboolean
 475 mono_w32file_set_cwd (const gunichar2 *path);
 476
 477 gboolean
 478 mono_w32file_create_pipe (gpointer *readpipe, gpointer *writepipe, guint32 size);
 479
 480 gint32
 481 mono_w32file_get_logical_drive (guint32 len, gunichar2 *buf);
 482
 483 gboolean
 484 mono_w32file_get_disk_free_space (const gunichar2 *path_name, guint64 *free_bytes_avail, guint64 *total_number_of_bytes, guint64 *total_number_of_free_bytes);
 485
 486 guint32
 487 mono_w32file_get_drive_type (const gunichar2 *root_path_name);
 488
 489 gboolean
 490 mono_w32file_get_volume_information (const gunichar2 *path, gunichar2 *volumename, gint volumesize, gint *outserial, gint *maxcomp, gint *fsflags, gunichar2 *fsbuffer, gint fsbuffersize);
 491
 492 G_END_DECLS
 493
 494 #endif /* _MONO_METADATA_W32FILE_H_ */