1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
|
/* $Id: fileio-win.cpp $ */
/** @file
* IPRT - File I/O, native implementation for the Windows host platform.
*/
/*
* Copyright (C) 2006-2020 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#define LOG_GROUP RTLOGGROUP_DIR
#ifndef _WIN32_WINNT
# define _WIN32_WINNT 0x0500
#endif
#include <iprt/nt/nt-and-windows.h>
#include <iprt/file.h>
#include <iprt/asm.h>
#include <iprt/assert.h>
#include <iprt/path.h>
#include <iprt/string.h>
#include <iprt/err.h>
#include <iprt/ldr.h>
#include <iprt/log.h>
#include <iprt/utf16.h>
#include "internal/file.h"
#include "internal/fs.h"
#include "internal/path.h"
#include "internal-r3-win.h" /* For g_enmWinVer + kRTWinOSType_XXX */
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
typedef BOOL WINAPI FNVERIFYCONSOLEIOHANDLE(HANDLE);
typedef FNVERIFYCONSOLEIOHANDLE *PFNVERIFYCONSOLEIOHANDLE; /* No, nobody fell on the keyboard, really! */
/**
* This is wrapper around the ugly SetFilePointer api.
*
* It's equivalent to SetFilePointerEx which we so unfortunately cannot use because of
* it not being present in NT4 GA.
*
* @returns Success indicator. Extended error information obtainable using GetLastError().
* @param hFile Filehandle.
* @param offSeek Offset to seek.
* @param poffNew Where to store the new file offset. NULL allowed.
* @param uMethod Seek method. (The windows one!)
*/
DECLINLINE(bool) MySetFilePointer(RTFILE hFile, uint64_t offSeek, uint64_t *poffNew, unsigned uMethod)
{
bool fRc;
LARGE_INTEGER off;
off.QuadPart = offSeek;
#if 1
if (off.LowPart != INVALID_SET_FILE_POINTER)
{
off.LowPart = SetFilePointer((HANDLE)RTFileToNative(hFile), off.LowPart, &off.HighPart, uMethod);
fRc = off.LowPart != INVALID_SET_FILE_POINTER;
}
else
{
SetLastError(NO_ERROR);
off.LowPart = SetFilePointer((HANDLE)RTFileToNative(hFile), off.LowPart, &off.HighPart, uMethod);
fRc = GetLastError() == NO_ERROR;
}
#else
fRc = SetFilePointerEx((HANDLE)RTFileToNative(hFile), off, &off, uMethod);
#endif
if (fRc && poffNew)
*poffNew = off.QuadPart;
return fRc;
}
/**
* Helper for checking if a VERR_DISK_FULL isn't a VERR_FILE_TOO_BIG.
* @returns VERR_DISK_FULL or VERR_FILE_TOO_BIG.
*/
static int rtFileWinCheckIfDiskReallyFull(RTFILE hFile, uint64_t cbDesired)
{
/*
* Windows doesn't appear to have a way to query the file size limit of a
* file system, so we have to deduce the limit from the file system driver name.
* This means it will only work for known file systems.
*/
if (cbDesired >= _2G - 1)
{
uint64_t cbMaxFile = UINT64_MAX;
RTFSTYPE enmFsType;
int rc = rtNtQueryFsType((HANDLE)RTFileToNative(hFile), &enmFsType);
if (RT_SUCCESS(rc))
switch (enmFsType)
{
case RTFSTYPE_NTFS:
case RTFSTYPE_EXFAT:
case RTFSTYPE_UDF:
cbMaxFile = UINT64_C(0xffffffffffffffff); /* (May be limited by IFS.) */
break;
case RTFSTYPE_ISO9660:
cbMaxFile = 8 *_1T;
break;
case RTFSTYPE_FAT:
cbMaxFile = _4G;
break;
case RTFSTYPE_HPFS:
cbMaxFile = _2G;
break;
default:
break;
}
if (cbDesired >= cbMaxFile)
return VERR_FILE_TOO_BIG;
}
return VERR_DISK_FULL;
}
RTR3DECL(int) RTFileFromNative(PRTFILE pFile, RTHCINTPTR uNative)
{
HANDLE h = (HANDLE)uNative;
AssertCompile(sizeof(h) == sizeof(uNative));
if (h == INVALID_HANDLE_VALUE)
{
AssertMsgFailed(("%p\n", uNative));
*pFile = NIL_RTFILE;
return VERR_INVALID_HANDLE;
}
*pFile = (RTFILE)h;
return VINF_SUCCESS;
}
RTR3DECL(RTHCINTPTR) RTFileToNative(RTFILE hFile)
{
AssertReturn(hFile != NIL_RTFILE, (RTHCINTPTR)INVALID_HANDLE_VALUE);
return (RTHCINTPTR)hFile;
}
RTR3DECL(int) RTFileOpen(PRTFILE pFile, const char *pszFilename, uint64_t fOpen)
{
return RTFileOpenEx(pszFilename, fOpen, pFile, NULL);
}
RTDECL(int) RTFileOpenEx(const char *pszFilename, uint64_t fOpen, PRTFILE phFile, PRTFILEACTION penmActionTaken)
{
/*
* Validate input.
*/
AssertReturn(phFile, VERR_INVALID_PARAMETER);
*phFile = NIL_RTFILE;
if (penmActionTaken)
*penmActionTaken = RTFILEACTION_INVALID;
AssertReturn(pszFilename, VERR_INVALID_PARAMETER);
/*
* Merge forced open flags and validate them.
*/
int rc = rtFileRecalcAndValidateFlags(&fOpen);
if (RT_FAILURE(rc))
return rc;
/*
* Determine disposition, access, share mode, creation flags, and security attributes
* for the CreateFile API call.
*/
DWORD dwCreationDisposition;
switch (fOpen & RTFILE_O_ACTION_MASK)
{
case RTFILE_O_OPEN:
dwCreationDisposition = fOpen & RTFILE_O_TRUNCATE ? TRUNCATE_EXISTING : OPEN_EXISTING;
break;
case RTFILE_O_OPEN_CREATE:
dwCreationDisposition = OPEN_ALWAYS;
break;
case RTFILE_O_CREATE:
dwCreationDisposition = CREATE_NEW;
break;
case RTFILE_O_CREATE_REPLACE:
dwCreationDisposition = CREATE_ALWAYS;
break;
default:
AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
}
DWORD dwDesiredAccess;
switch (fOpen & RTFILE_O_ACCESS_MASK)
{
case RTFILE_O_READ:
dwDesiredAccess = FILE_GENERIC_READ; /* RTFILE_O_APPEND is ignored. */
break;
case RTFILE_O_WRITE:
dwDesiredAccess = fOpen & RTFILE_O_APPEND
? FILE_GENERIC_WRITE & ~FILE_WRITE_DATA
: FILE_GENERIC_WRITE;
break;
case RTFILE_O_READWRITE:
dwDesiredAccess = fOpen & RTFILE_O_APPEND
? FILE_GENERIC_READ | (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
: FILE_GENERIC_READ | FILE_GENERIC_WRITE;
break;
case RTFILE_O_ATTR_ONLY:
if (fOpen & RTFILE_O_ACCESS_ATTR_MASK)
{
dwDesiredAccess = 0;
break;
}
RT_FALL_THRU();
default:
AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
}
if (dwCreationDisposition == TRUNCATE_EXISTING)
/* Required for truncating the file (see MSDN), it is *NOT* part of FILE_GENERIC_WRITE. */
dwDesiredAccess |= GENERIC_WRITE;
/* RTFileSetMode needs following rights as well. */
switch (fOpen & RTFILE_O_ACCESS_ATTR_MASK)
{
case RTFILE_O_ACCESS_ATTR_READ: dwDesiredAccess |= FILE_READ_ATTRIBUTES | SYNCHRONIZE; break;
case RTFILE_O_ACCESS_ATTR_WRITE: dwDesiredAccess |= FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
case RTFILE_O_ACCESS_ATTR_READWRITE: dwDesiredAccess |= FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
default:
/* Attributes access is the same as the file access. */
switch (fOpen & RTFILE_O_ACCESS_MASK)
{
case RTFILE_O_READ: dwDesiredAccess |= FILE_READ_ATTRIBUTES | SYNCHRONIZE; break;
case RTFILE_O_WRITE: dwDesiredAccess |= FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
case RTFILE_O_READWRITE: dwDesiredAccess |= FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
default:
AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
}
}
DWORD dwShareMode;
switch (fOpen & RTFILE_O_DENY_MASK)
{
case RTFILE_O_DENY_NONE: dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE; break;
case RTFILE_O_DENY_READ: dwShareMode = FILE_SHARE_WRITE; break;
case RTFILE_O_DENY_WRITE: dwShareMode = FILE_SHARE_READ; break;
case RTFILE_O_DENY_READWRITE: dwShareMode = 0; break;
case RTFILE_O_DENY_NOT_DELETE: dwShareMode = FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE; break;
case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_READ: dwShareMode = FILE_SHARE_DELETE | FILE_SHARE_WRITE; break;
case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_WRITE: dwShareMode = FILE_SHARE_DELETE | FILE_SHARE_READ; break;
case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_READWRITE:dwShareMode = FILE_SHARE_DELETE; break;
default:
AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
}
SECURITY_ATTRIBUTES SecurityAttributes;
PSECURITY_ATTRIBUTES pSecurityAttributes = NULL;
if (fOpen & RTFILE_O_INHERIT)
{
SecurityAttributes.nLength = sizeof(SecurityAttributes);
SecurityAttributes.lpSecurityDescriptor = NULL;
SecurityAttributes.bInheritHandle = TRUE;
pSecurityAttributes = &SecurityAttributes;
}
DWORD dwFlagsAndAttributes;
dwFlagsAndAttributes = FILE_ATTRIBUTE_NORMAL;
if (fOpen & RTFILE_O_WRITE_THROUGH)
dwFlagsAndAttributes |= FILE_FLAG_WRITE_THROUGH;
if (fOpen & RTFILE_O_ASYNC_IO)
dwFlagsAndAttributes |= FILE_FLAG_OVERLAPPED;
if (fOpen & RTFILE_O_NO_CACHE)
{
dwFlagsAndAttributes |= FILE_FLAG_NO_BUFFERING;
dwDesiredAccess &= ~FILE_APPEND_DATA;
}
/*
* Open/Create the file.
*/
PRTUTF16 pwszFilename;
rc = RTPathWinFromUtf8(&pwszFilename, pszFilename, 0 /*fFlags*/);
if (RT_SUCCESS(rc))
{
HANDLE hFile = CreateFileW(pwszFilename,
dwDesiredAccess,
dwShareMode,
pSecurityAttributes,
dwCreationDisposition,
dwFlagsAndAttributes,
NULL);
DWORD const dwErr = GetLastError();
if (hFile != INVALID_HANDLE_VALUE)
{
/*
* Calculate the action taken value.
*/
RTFILEACTION enmActionTaken;
switch (dwCreationDisposition)
{
case CREATE_NEW:
enmActionTaken = RTFILEACTION_CREATED;
break;
case CREATE_ALWAYS:
AssertMsg(dwErr == ERROR_ALREADY_EXISTS || dwErr == NO_ERROR, ("%u\n", dwErr));
enmActionTaken = dwErr == ERROR_ALREADY_EXISTS ? RTFILEACTION_REPLACED : RTFILEACTION_CREATED;
break;
case OPEN_EXISTING:
enmActionTaken = RTFILEACTION_OPENED;
break;
case OPEN_ALWAYS:
AssertMsg(dwErr == ERROR_ALREADY_EXISTS || dwErr == NO_ERROR, ("%u\n", dwErr));
enmActionTaken = dwErr == ERROR_ALREADY_EXISTS ? RTFILEACTION_OPENED : RTFILEACTION_CREATED;
break;
case TRUNCATE_EXISTING:
enmActionTaken = RTFILEACTION_TRUNCATED;
break;
default:
AssertMsgFailed(("%d %#x\n", dwCreationDisposition, dwCreationDisposition));
enmActionTaken = RTFILEACTION_INVALID;
break;
}
/*
* Turn off indexing of directory through Windows Indexing Service if
* we created a new file or replaced an existing one.
*/
if ( (fOpen & RTFILE_O_NOT_CONTENT_INDEXED)
&& ( enmActionTaken == RTFILEACTION_CREATED
|| enmActionTaken == RTFILEACTION_REPLACED) )
{
/** @todo there must be a way to do this via the handle! */
if (!SetFileAttributesW(pwszFilename, FILE_ATTRIBUTE_NOT_CONTENT_INDEXED))
rc = RTErrConvertFromWin32(GetLastError());
}
/*
* If RTFILEACTION_OPENED, we may need to truncate the file.
*/
else if ( (fOpen & (RTFILE_O_TRUNCATE | RTFILE_O_ACTION_MASK)) == (RTFILE_O_TRUNCATE | RTFILE_O_OPEN_CREATE)
&& enmActionTaken == RTFILEACTION_OPENED)
{
if (SetEndOfFile(hFile))
enmActionTaken = RTFILEACTION_TRUNCATED;
else
rc = RTErrConvertFromWin32(GetLastError());
}
if (penmActionTaken)
*penmActionTaken = enmActionTaken;
if (RT_SUCCESS(rc))
{
*phFile = (RTFILE)hFile;
Assert((HANDLE)*phFile == hFile);
RTPathWinFree(pwszFilename);
return VINF_SUCCESS;
}
CloseHandle(hFile);
}
else
{
if ( penmActionTaken
&& dwCreationDisposition == CREATE_NEW
&& dwErr == ERROR_FILE_EXISTS)
*penmActionTaken = RTFILEACTION_ALREADY_EXISTS;
rc = RTErrConvertFromWin32(dwErr);
}
RTPathWinFree(pwszFilename);
}
return rc;
}
RTR3DECL(int) RTFileOpenBitBucket(PRTFILE phFile, uint64_t fAccess)
{
AssertReturn( fAccess == RTFILE_O_READ
|| fAccess == RTFILE_O_WRITE
|| fAccess == RTFILE_O_READWRITE,
VERR_INVALID_PARAMETER);
return RTFileOpen(phFile, "NUL", fAccess | RTFILE_O_DENY_NONE | RTFILE_O_OPEN);
}
RTR3DECL(int) RTFileClose(RTFILE hFile)
{
if (hFile == NIL_RTFILE)
return VINF_SUCCESS;
if (CloseHandle((HANDLE)RTFileToNative(hFile)))
return VINF_SUCCESS;
return RTErrConvertFromWin32(GetLastError());
}
RTFILE rtFileGetStandard(RTHANDLESTD enmStdHandle)
{
DWORD dwStdHandle;
switch (enmStdHandle)
{
case RTHANDLESTD_INPUT: dwStdHandle = STD_INPUT_HANDLE; break;
case RTHANDLESTD_OUTPUT: dwStdHandle = STD_OUTPUT_HANDLE; break;
case RTHANDLESTD_ERROR: dwStdHandle = STD_ERROR_HANDLE; break;
default:
AssertFailedReturn(NIL_RTFILE);
}
HANDLE hNative = GetStdHandle(dwStdHandle);
if (hNative == INVALID_HANDLE_VALUE)
return NIL_RTFILE;
RTFILE hFile = (RTFILE)(uintptr_t)hNative;
AssertReturn((HANDLE)(uintptr_t)hFile == hNative, NIL_RTFILE);
return hFile;
}
RTR3DECL(int) RTFileSeek(RTFILE hFile, int64_t offSeek, unsigned uMethod, uint64_t *poffActual)
{
static ULONG aulSeekRecode[] =
{
FILE_BEGIN,
FILE_CURRENT,
FILE_END,
};
/*
* Validate input.
*/
if (uMethod > RTFILE_SEEK_END)
{
AssertMsgFailed(("Invalid uMethod=%d\n", uMethod));
return VERR_INVALID_PARAMETER;
}
/*
* Execute the seek.
*/
if (MySetFilePointer(hFile, offSeek, poffActual, aulSeekRecode[uMethod]))
return VINF_SUCCESS;
return RTErrConvertFromWin32(GetLastError());
}
RTR3DECL(int) RTFileRead(RTFILE hFile, void *pvBuf, size_t cbToRead, size_t *pcbRead)
{
if (cbToRead <= 0)
{
if (pcbRead)
*pcbRead = 0;
return VINF_SUCCESS;
}
ULONG cbToReadAdj = (ULONG)cbToRead;
AssertReturn(cbToReadAdj == cbToRead, VERR_NUMBER_TOO_BIG);
ULONG cbRead = 0;
if (ReadFile((HANDLE)RTFileToNative(hFile), pvBuf, cbToReadAdj, &cbRead, NULL))
{
if (pcbRead)
/* Caller can handle partial reads. */
*pcbRead = cbRead;
else
{
/* Caller expects everything to be read. */
while (cbToReadAdj > cbRead)
{
ULONG cbReadPart = 0;
if (!ReadFile((HANDLE)RTFileToNative(hFile), (char*)pvBuf + cbRead, cbToReadAdj - cbRead, &cbReadPart, NULL))
return RTErrConvertFromWin32(GetLastError());
if (cbReadPart == 0)
return VERR_EOF;
cbRead += cbReadPart;
}
}
return VINF_SUCCESS;
}
/*
* If it's a console, we might bump into out of memory conditions in the
* ReadConsole call.
*/
DWORD dwErr = GetLastError();
if (dwErr == ERROR_NOT_ENOUGH_MEMORY)
{
ULONG cbChunk = cbToReadAdj / 2;
if (cbChunk > 16*_1K)
cbChunk = 16*_1K;
else
cbChunk = RT_ALIGN_32(cbChunk, 256);
cbRead = 0;
while (cbToReadAdj > cbRead)
{
ULONG cbToRead = RT_MIN(cbChunk, cbToReadAdj - cbRead);
ULONG cbReadPart = 0;
if (!ReadFile((HANDLE)RTFileToNative(hFile), (char *)pvBuf + cbRead, cbToRead, &cbReadPart, NULL))
{
/* If we failed because the buffer is too big, shrink it and
try again. */
dwErr = GetLastError();
if ( dwErr == ERROR_NOT_ENOUGH_MEMORY
&& cbChunk > 8)
{
cbChunk /= 2;
continue;
}
return RTErrConvertFromWin32(dwErr);
}
cbRead += cbReadPart;
/* Return if the caller can handle partial reads, otherwise try
fill the buffer all the way up. */
if (pcbRead)
{
*pcbRead = cbRead;
break;
}
if (cbReadPart == 0)
return VERR_EOF;
}
return VINF_SUCCESS;
}
return RTErrConvertFromWin32(dwErr);
}
RTDECL(int) RTFileReadAt(RTFILE hFile, RTFOFF off, void *pvBuf, size_t cbToRead, size_t *pcbRead)
{
ULONG cbToReadAdj = (ULONG)cbToRead;
AssertReturn(cbToReadAdj == cbToRead, VERR_NUMBER_TOO_BIG);
OVERLAPPED Overlapped;
Overlapped.Offset = (uint32_t)off;
Overlapped.OffsetHigh = (uint32_t)(off >> 32);
Overlapped.hEvent = NULL;
Overlapped.Internal = 0;
Overlapped.InternalHigh = 0;
ULONG cbRead = 0;
if (ReadFile((HANDLE)RTFileToNative(hFile), pvBuf, cbToReadAdj, &cbRead, &Overlapped))
{
if (pcbRead)
/* Caller can handle partial reads. */
*pcbRead = cbRead;
else
{
/* Caller expects everything to be read. */
while (cbToReadAdj > cbRead)
{
Overlapped.Offset = (uint32_t)(off + cbRead);
Overlapped.OffsetHigh = (uint32_t)((off + cbRead) >> 32);
Overlapped.hEvent = NULL;
Overlapped.Internal = 0;
Overlapped.InternalHigh = 0;
ULONG cbReadPart = 0;
if (!ReadFile((HANDLE)RTFileToNative(hFile), (char *)pvBuf + cbRead, cbToReadAdj - cbRead,
&cbReadPart, &Overlapped))
return RTErrConvertFromWin32(GetLastError());
if (cbReadPart == 0)
return VERR_EOF;
cbRead += cbReadPart;
}
}
return VINF_SUCCESS;
}
/* We will get an EOF error when using overlapped I/O. So, make sure we don't
return it when pcbhRead is not NULL. */
DWORD dwErr = GetLastError();
if (pcbRead && dwErr == ERROR_HANDLE_EOF)
{
*pcbRead = 0;
return VINF_SUCCESS;
}
return RTErrConvertFromWin32(dwErr);
}
RTR3DECL(int) RTFileWrite(RTFILE hFile, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten)
{
if (cbToWrite <= 0)
return VINF_SUCCESS;
ULONG const cbToWriteAdj = (ULONG)cbToWrite;
AssertReturn(cbToWriteAdj == cbToWrite, VERR_NUMBER_TOO_BIG);
ULONG cbWritten = 0;
if (WriteFile((HANDLE)RTFileToNative(hFile), pvBuf, cbToWriteAdj, &cbWritten, NULL))
{
if (pcbWritten)
/* Caller can handle partial writes. */
*pcbWritten = RT_MIN(cbWritten, cbToWriteAdj); /* paranoia^3 */
else
{
/* Caller expects everything to be written. */
while (cbWritten < cbToWriteAdj)
{
ULONG cbWrittenPart = 0;
if (!WriteFile((HANDLE)RTFileToNative(hFile), (char*)pvBuf + cbWritten,
cbToWriteAdj - cbWritten, &cbWrittenPart, NULL))
{
int rc = RTErrConvertFromWin32(GetLastError());
if (rc == VERR_DISK_FULL)
rc = rtFileWinCheckIfDiskReallyFull(hFile, RTFileTell(hFile) + cbToWriteAdj - cbWritten);
return rc;
}
if (cbWrittenPart == 0)
return VERR_WRITE_ERROR;
cbWritten += cbWrittenPart;
}
}
return VINF_SUCCESS;
}
/*
* If it's a console, we might bump into out of memory conditions in the
* WriteConsole call.
*/
DWORD dwErr = GetLastError();
if (dwErr == ERROR_NOT_ENOUGH_MEMORY)
{
ULONG cbChunk = cbToWriteAdj / 2;
if (cbChunk > _32K)
cbChunk = _32K;
else
cbChunk = RT_ALIGN_32(cbChunk, 256);
cbWritten = 0;
while (cbWritten < cbToWriteAdj)
{
ULONG cbToWrite = RT_MIN(cbChunk, cbToWriteAdj - cbWritten);
ULONG cbWrittenPart = 0;
if (!WriteFile((HANDLE)RTFileToNative(hFile), (const char *)pvBuf + cbWritten, cbToWrite, &cbWrittenPart, NULL))
{
/* If we failed because the buffer is too big, shrink it and
try again. */
dwErr = GetLastError();
if ( dwErr == ERROR_NOT_ENOUGH_MEMORY
&& cbChunk > 8)
{
cbChunk /= 2;
continue;
}
int rc = RTErrConvertFromWin32(dwErr);
if (rc == VERR_DISK_FULL)
rc = rtFileWinCheckIfDiskReallyFull(hFile, RTFileTell(hFile) + cbToWrite);
return rc;
}
cbWritten += cbWrittenPart;
/* Return if the caller can handle partial writes, otherwise try
write out everything. */
if (pcbWritten)
{
*pcbWritten = RT_MIN(cbWritten, cbToWriteAdj); /* paranoia^3 */
break;
}
if (cbWrittenPart == 0)
return VERR_WRITE_ERROR;
}
return VINF_SUCCESS;
}
int rc = RTErrConvertFromWin32(dwErr);
if (rc == VERR_DISK_FULL)
rc = rtFileWinCheckIfDiskReallyFull(hFile, RTFileTell(hFile) + cbToWriteAdj);
return rc;
}
RTDECL(int) RTFileWriteAt(RTFILE hFile, RTFOFF off, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten)
{
ULONG const cbToWriteAdj = (ULONG)cbToWrite;
AssertReturn(cbToWriteAdj == cbToWrite, VERR_NUMBER_TOO_BIG);
OVERLAPPED Overlapped;
Overlapped.Offset = (uint32_t)off;
Overlapped.OffsetHigh = (uint32_t)(off >> 32);
Overlapped.hEvent = NULL;
Overlapped.Internal = 0;
Overlapped.InternalHigh = 0;
ULONG cbWritten = 0;
if (WriteFile((HANDLE)RTFileToNative(hFile), pvBuf, cbToWriteAdj, &cbWritten, &Overlapped))
{
if (pcbWritten)
/* Caller can handle partial writes. */
*pcbWritten = RT_MIN(cbWritten, cbToWriteAdj); /* paranoia^3 */
else
{
/* Caller expects everything to be written. */
while (cbWritten < cbToWriteAdj)
{
Overlapped.Offset = (uint32_t)(off + cbWritten);
Overlapped.OffsetHigh = (uint32_t)((off + cbWritten) >> 32);
Overlapped.hEvent = NULL;
Overlapped.Internal = 0;
Overlapped.InternalHigh = 0;
ULONG cbWrittenPart = 0;
if (!WriteFile((HANDLE)RTFileToNative(hFile), (char*)pvBuf + cbWritten,
cbToWriteAdj - cbWritten, &cbWrittenPart, &Overlapped))
{
int rc = RTErrConvertFromWin32(GetLastError());
if (rc == VERR_DISK_FULL)
rc = rtFileWinCheckIfDiskReallyFull(hFile, off + cbToWriteAdj);
return rc;
}
if (cbWrittenPart == 0)
return VERR_WRITE_ERROR;
cbWritten += cbWrittenPart;
}
}
return VINF_SUCCESS;
}
int rc = RTErrConvertFromWin32(GetLastError());
if (rc == VERR_DISK_FULL)
rc = rtFileWinCheckIfDiskReallyFull(hFile, off + cbToWriteAdj);
return rc;
}
RTR3DECL(int) RTFileFlush(RTFILE hFile)
{
if (!FlushFileBuffers((HANDLE)RTFileToNative(hFile)))
{
int rc = GetLastError();
Log(("FlushFileBuffers failed with %d\n", rc));
return RTErrConvertFromWin32(rc);
}
return VINF_SUCCESS;
}
#if 1
/**
* Checks the the two handles refers to the same file.
*
* @returns true if the same file, false if different ones or invalid handles.
* @param hFile1 Handle \#1.
* @param hFile2 Handle \#2.
*/
static bool rtFileIsSame(HANDLE hFile1, HANDLE hFile2)
{
/*
* We retry in case CreationTime or the Object ID is being modified and there
* aren't any IndexNumber (file ID) on this kind of file system.
*/
for (uint32_t iTries = 0; iTries < 3; iTries++)
{
/*
* Fetch data to compare (being a little lazy here).
*/
struct
{
HANDLE hFile;
NTSTATUS rcObjId;
FILE_OBJECTID_INFORMATION ObjId;
FILE_ALL_INFORMATION All;
FILE_FS_VOLUME_INFORMATION Vol;
} auData[2];
auData[0].hFile = hFile1;
auData[1].hFile = hFile2;
for (uintptr_t i = 0; i < RT_ELEMENTS(auData); i++)
{
RT_ZERO(auData[i].ObjId);
IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
auData[i].rcObjId = NtQueryInformationFile(auData[i].hFile, &Ios, &auData[i].ObjId, sizeof(auData[i].ObjId),
FileObjectIdInformation);
RT_ZERO(auData[i].All);
RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
NTSTATUS rcNt = NtQueryInformationFile(auData[i].hFile, &Ios, &auData[i].All, sizeof(auData[i].All),
FileAllInformation);
AssertReturn(rcNt == STATUS_BUFFER_OVERFLOW /* insufficient space for name info */ || NT_SUCCESS(rcNt), false);
union
{
FILE_FS_VOLUME_INFORMATION Info;
uint8_t abBuf[sizeof(FILE_FS_VOLUME_INFORMATION) + 4096];
} uVol;
RT_ZERO(uVol.Info);
RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
rcNt = NtQueryVolumeInformationFile(auData[i].hFile, &Ios, &uVol, sizeof(uVol), FileFsVolumeInformation);
if (NT_SUCCESS(rcNt))
auData[i].Vol = uVol.Info;
else
RT_ZERO(auData[i].Vol);
}
/*
* Compare it.
*/
if ( auData[0].All.StandardInformation.Directory
== auData[1].All.StandardInformation.Directory)
{ /* likely */ }
else
break;
if ( (auData[0].All.BasicInformation.FileAttributes & (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_DEVICE | FILE_ATTRIBUTE_REPARSE_POINT))
== (auData[1].All.BasicInformation.FileAttributes & (FILE_ATTRIBUTE_DIRECTORY | FILE_ATTRIBUTE_DEVICE | FILE_ATTRIBUTE_REPARSE_POINT)))
{ /* likely */ }
else
break;
if ( auData[0].Vol.VolumeSerialNumber
== auData[1].Vol.VolumeSerialNumber)
{ /* likely */ }
else
break;
if ( auData[0].All.InternalInformation.IndexNumber.QuadPart
== auData[1].All.InternalInformation.IndexNumber.QuadPart)
{ /* likely */ }
else
break;
if ( !NT_SUCCESS(auData[0].rcObjId)
|| memcmp(&auData[0].ObjId, &auData[1].ObjId, RT_UOFFSETOF(FILE_OBJECTID_INFORMATION, ExtendedInfo)) == 0)
{
if ( auData[0].All.BasicInformation.CreationTime.QuadPart
== auData[1].All.BasicInformation.CreationTime.QuadPart)
return true;
}
}
return false;
}
/**
* If @a hFile is opened in append mode, try return a handle with
* FILE_WRITE_DATA permissions.
*
* @returns Duplicate handle.
* @param hFile The NT handle to check & duplicate.
*
* @todo It would be much easier to implement this by not dropping the
* FILE_WRITE_DATA access and instead have the RTFileWrite APIs
* enforce the appending. That will require keeping additional
* information along side the handle (instance structure). However, on
* windows you can grant append permissions w/o giving people access to
* overwrite existing data, so the RTFileOpenEx code would have to deal
* with those kinds of STATUS_ACCESS_DENIED too then.
*/
static HANDLE rtFileReOpenAppendOnlyWithFullWriteAccess(HANDLE hFile)
{
OBJECT_BASIC_INFORMATION BasicInfo = {0};
ULONG cbActual = 0;
NTSTATUS rcNt = NtQueryObject(hFile, ObjectBasicInformation, &BasicInfo, sizeof(BasicInfo), &cbActual);
if (NT_SUCCESS(rcNt))
{
if ((BasicInfo.GrantedAccess & (FILE_APPEND_DATA | FILE_WRITE_DATA)) == FILE_APPEND_DATA)
{
/*
* We cannot use NtDuplicateObject here as it is not possible to
* upgrade the access on files, only making it more strict. So,
* query the path and re-open it (we could do by file/object/whatever
* id too, but that may not work with all file systems).
*/
for (uint32_t i = 0; i < 16; i++)
{
UNICODE_STRING NtName;
int rc = RTNtPathFromHandle(&NtName, hFile, 0);
AssertRCReturn(rc, INVALID_HANDLE_VALUE);
HANDLE hDupFile = RTNT_INVALID_HANDLE_VALUE;
IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
OBJECT_ATTRIBUTES ObjAttr;
InitializeObjectAttributes(&ObjAttr, &NtName, BasicInfo.Attributes & ~OBJ_INHERIT, NULL, NULL);
NTSTATUS rcNt = NtCreateFile(&hDupFile,
BasicInfo.GrantedAccess | FILE_WRITE_DATA,
&ObjAttr,
&Ios,
NULL /* AllocationSize*/,
FILE_ATTRIBUTE_NORMAL,
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
FILE_OPEN,
FILE_OPEN_FOR_BACKUP_INTENT /*??*/,
NULL /*EaBuffer*/,
0 /*EaLength*/);
RTUtf16Free(NtName.Buffer);
if (NT_SUCCESS(rcNt))
{
/*
* Check that we've opened the same file.
*/
if (rtFileIsSame(hFile, hDupFile))
return hDupFile;
NtClose(hDupFile);
}
}
AssertFailed();
}
}
return INVALID_HANDLE_VALUE;
}
#endif
RTR3DECL(int) RTFileSetSize(RTFILE hFile, uint64_t cbSize)
{
#if 1
HANDLE hNtFile = (HANDLE)RTFileToNative(hFile);
HANDLE hDupFile = INVALID_HANDLE_VALUE;
union
{
FILE_END_OF_FILE_INFORMATION Eof;
FILE_ALLOCATION_INFORMATION Alloc;
} uInfo;
/*
* Change the EOF marker.
*
* HACK ALERT! If the file was opened in RTFILE_O_APPEND mode, we will have
* to re-open it with FILE_WRITE_DATA access to get the job done.
* This how ftruncate on a unixy system would work but not how
* it is done on Windows where appending is a separate permission
* rather than just a write modifier, making this hack totally wrong.
*/
/** @todo The right way to fix this is either to add a RTFileSetSizeEx function
* for specifically requesting the unixy behaviour, or add an additional
* flag to RTFileOpen[Ex] to request the unixy append behaviour there.
* The latter would require saving the open flags in a instance data
* structure, which is a bit of a risky move, though something we should
* do in 6.2 (or later).
*
* Note! Because handle interitance, it is not realyan option to
* always use FILE_WRITE_DATA and implement the RTFILE_O_APPEND
* bits in RTFileWrite and friends. Besides, it's not like
* RTFILE_O_APPEND is so clearly defined anyway - see
* RTFileWriteAt.
*/
IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
uInfo.Eof.EndOfFile.QuadPart = cbSize;
NTSTATUS rcNt = NtSetInformationFile(hNtFile, &Ios, &uInfo.Eof, sizeof(uInfo.Eof), FileEndOfFileInformation);
if (rcNt == STATUS_ACCESS_DENIED)
{
hDupFile = rtFileReOpenAppendOnlyWithFullWriteAccess(hNtFile);
if (hDupFile != INVALID_HANDLE_VALUE)
{
hNtFile = hDupFile;
uInfo.Eof.EndOfFile.QuadPart = cbSize;
rcNt = NtSetInformationFile(hNtFile, &Ios, &uInfo.Eof, sizeof(uInfo.Eof), FileEndOfFileInformation);
}
}
if (NT_SUCCESS(rcNt))
{
/*
* Change the allocation.
*/
uInfo.Alloc.AllocationSize.QuadPart = cbSize;
rcNt = NtSetInformationFile(hNtFile, &Ios, &uInfo.Eof, sizeof(uInfo.Alloc), FileAllocationInformation);
}
/*
* Close the temporary file handle:
*/
if (hDupFile != INVALID_HANDLE_VALUE)
NtClose(hDupFile);
if (RT_SUCCESS(rcNt))
return VINF_SUCCESS;
return RTErrConvertFromNtStatus(rcNt);
#else /* this version of the code will fail to truncate files when RTFILE_O_APPEND is in effect, which isn't what we want... */
/*
* Get current file pointer.
*/
int rc;
uint64_t offCurrent;
if (MySetFilePointer(hFile, 0, &offCurrent, FILE_CURRENT))
{
/*
* Set new file pointer.
*/
if (MySetFilePointer(hFile, cbSize, NULL, FILE_BEGIN))
{
/* set file pointer */
if (SetEndOfFile((HANDLE)RTFileToNative(hFile)))
{
/*
* Restore file pointer and return.
* If the old pointer was beyond the new file end, ignore failure.
*/
if ( MySetFilePointer(hFile, offCurrent, NULL, FILE_BEGIN)
|| offCurrent > cbSize)
return VINF_SUCCESS;
}
/*
* Failed, try restoring the file pointer.
*/
rc = GetLastError();
MySetFilePointer(hFile, offCurrent, NULL, FILE_BEGIN);
if (rc == ERROR_DISK_FULL)
return rtFileWinCheckIfDiskReallyFull(hFile, cbSize);
}
else
rc = GetLastError();
}
else
rc = GetLastError();
return RTErrConvertFromWin32(rc);
#endif
}
RTR3DECL(int) RTFileQuerySize(RTFILE hFile, uint64_t *pcbSize)
{
/*
* GetFileSize works for most handles.
*/
ULARGE_INTEGER Size;
Size.LowPart = GetFileSize((HANDLE)RTFileToNative(hFile), &Size.HighPart);
if (Size.LowPart != INVALID_FILE_SIZE)
{
*pcbSize = Size.QuadPart;
return VINF_SUCCESS;
}
int rc = RTErrConvertFromWin32(GetLastError());
/*
* Could it be a volume or a disk?
*/
DISK_GEOMETRY DriveGeo;
DWORD cbDriveGeo;
if (DeviceIoControl((HANDLE)RTFileToNative(hFile),
IOCTL_DISK_GET_DRIVE_GEOMETRY, NULL, 0,
&DriveGeo, sizeof(DriveGeo), &cbDriveGeo, NULL))
{
if ( DriveGeo.MediaType == FixedMedia
|| DriveGeo.MediaType == RemovableMedia)
{
*pcbSize = DriveGeo.Cylinders.QuadPart
* DriveGeo.TracksPerCylinder
* DriveGeo.SectorsPerTrack
* DriveGeo.BytesPerSector;
GET_LENGTH_INFORMATION DiskLenInfo;
DWORD Ignored;
if (DeviceIoControl((HANDLE)RTFileToNative(hFile),
IOCTL_DISK_GET_LENGTH_INFO, NULL, 0,
&DiskLenInfo, sizeof(DiskLenInfo), &Ignored, (LPOVERLAPPED)NULL))
{
/* IOCTL_DISK_GET_LENGTH_INFO is supported -- override cbSize. */
*pcbSize = DiskLenInfo.Length.QuadPart;
}
return VINF_SUCCESS;
}
}
/*
* Return the GetFileSize result if not a volume/disk.
*/
return rc;
}
RTR3DECL(int) RTFileQueryMaxSizeEx(RTFILE hFile, PRTFOFF pcbMax)
{
/** @todo r=bird:
* We might have to make this code OS version specific... In the worse
* case, we'll have to try GetVolumeInformationByHandle on vista and fall
* back on NtQueryVolumeInformationFile(,,,, FileFsAttributeInformation)
* else where, and check for known file system names. (For LAN shares we'll
* have to figure out the remote file system.) */
RT_NOREF_PV(hFile); RT_NOREF_PV(pcbMax);
return VERR_NOT_IMPLEMENTED;
}
RTR3DECL(bool) RTFileIsValid(RTFILE hFile)
{
if (hFile != NIL_RTFILE)
{
DWORD dwType = GetFileType((HANDLE)RTFileToNative(hFile));
switch (dwType)
{
case FILE_TYPE_CHAR:
case FILE_TYPE_DISK:
case FILE_TYPE_PIPE:
case FILE_TYPE_REMOTE:
return true;
case FILE_TYPE_UNKNOWN:
if (GetLastError() == NO_ERROR)
return true;
break;
default:
break;
}
}
return false;
}
#define LOW_DWORD(u64) ((DWORD)u64)
#define HIGH_DWORD(u64) (((DWORD *)&u64)[1])
RTR3DECL(int) RTFileLock(RTFILE hFile, unsigned fLock, int64_t offLock, uint64_t cbLock)
{
Assert(offLock >= 0);
/* Check arguments. */
if (fLock & ~RTFILE_LOCK_MASK)
{
AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
return VERR_INVALID_PARAMETER;
}
/* Prepare flags. */
Assert(RTFILE_LOCK_WRITE);
DWORD dwFlags = (fLock & RTFILE_LOCK_WRITE) ? LOCKFILE_EXCLUSIVE_LOCK : 0;
Assert(RTFILE_LOCK_WAIT);
if (!(fLock & RTFILE_LOCK_WAIT))
dwFlags |= LOCKFILE_FAIL_IMMEDIATELY;
/* Windows structure. */
OVERLAPPED Overlapped;
memset(&Overlapped, 0, sizeof(Overlapped));
Overlapped.Offset = LOW_DWORD(offLock);
Overlapped.OffsetHigh = HIGH_DWORD(offLock);
/* Note: according to Microsoft, LockFileEx API call is available starting from NT 3.5 */
if (LockFileEx((HANDLE)RTFileToNative(hFile), dwFlags, 0, LOW_DWORD(cbLock), HIGH_DWORD(cbLock), &Overlapped))
return VINF_SUCCESS;
return RTErrConvertFromWin32(GetLastError());
}
RTR3DECL(int) RTFileChangeLock(RTFILE hFile, unsigned fLock, int64_t offLock, uint64_t cbLock)
{
Assert(offLock >= 0);
/* Check arguments. */
if (fLock & ~RTFILE_LOCK_MASK)
{
AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
return VERR_INVALID_PARAMETER;
}
/* Remove old lock. */
int rc = RTFileUnlock(hFile, offLock, cbLock);
if (RT_FAILURE(rc))
return rc;
/* Set new lock. */
rc = RTFileLock(hFile, fLock, offLock, cbLock);
if (RT_SUCCESS(rc))
return rc;
/* Try to restore old lock. */
unsigned fLockOld = (fLock & RTFILE_LOCK_WRITE) ? fLock & ~RTFILE_LOCK_WRITE : fLock | RTFILE_LOCK_WRITE;
rc = RTFileLock(hFile, fLockOld, offLock, cbLock);
if (RT_SUCCESS(rc))
return VERR_FILE_LOCK_VIOLATION;
else
return VERR_FILE_LOCK_LOST;
}
RTR3DECL(int) RTFileUnlock(RTFILE hFile, int64_t offLock, uint64_t cbLock)
{
Assert(offLock >= 0);
if (UnlockFile((HANDLE)RTFileToNative(hFile),
LOW_DWORD(offLock), HIGH_DWORD(offLock),
LOW_DWORD(cbLock), HIGH_DWORD(cbLock)))
return VINF_SUCCESS;
return RTErrConvertFromWin32(GetLastError());
}
RTR3DECL(int) RTFileQueryInfo(RTFILE hFile, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs)
{
/*
* Validate input.
*/
if (hFile == NIL_RTFILE)
{
AssertMsgFailed(("Invalid hFile=%RTfile\n", hFile));
return VERR_INVALID_PARAMETER;
}
if (!pObjInfo)
{
AssertMsgFailed(("Invalid pObjInfo=%p\n", pObjInfo));
return VERR_INVALID_PARAMETER;
}
if ( enmAdditionalAttribs < RTFSOBJATTRADD_NOTHING
|| enmAdditionalAttribs > RTFSOBJATTRADD_LAST)
{
AssertMsgFailed(("Invalid enmAdditionalAttribs=%p\n", enmAdditionalAttribs));
return VERR_INVALID_PARAMETER;
}
/*
* Query file info.
*/
HANDLE hHandle = (HANDLE)RTFileToNative(hFile);
#if 1
uint64_t auBuf[168 / sizeof(uint64_t)]; /* Missing FILE_ALL_INFORMATION here. */
int rc = rtPathNtQueryInfoFromHandle(hFile, auBuf, sizeof(auBuf), pObjInfo, enmAdditionalAttribs, NULL, 0);
if (RT_SUCCESS(rc))
return rc;
/*
* Console I/O handles make trouble here. On older windows versions they
* end up with ERROR_INVALID_HANDLE when handed to the above API, while on
* more recent ones they cause different errors to appear.
*
* Thus, we must ignore the latter and doubly verify invalid handle claims.
* We use the undocumented VerifyConsoleIoHandle to do this, falling back on
* GetFileType should it not be there.
*/
if ( rc == VERR_INVALID_HANDLE
|| rc == VERR_ACCESS_DENIED
|| rc == VERR_UNEXPECTED_FS_OBJ_TYPE)
{
static PFNVERIFYCONSOLEIOHANDLE s_pfnVerifyConsoleIoHandle = NULL;
static bool volatile s_fInitialized = false;
PFNVERIFYCONSOLEIOHANDLE pfnVerifyConsoleIoHandle;
if (s_fInitialized)
pfnVerifyConsoleIoHandle = s_pfnVerifyConsoleIoHandle;
else
{
pfnVerifyConsoleIoHandle = (PFNVERIFYCONSOLEIOHANDLE)RTLdrGetSystemSymbol("kernel32.dll", "VerifyConsoleIoHandle");
ASMAtomicWriteBool(&s_fInitialized, true);
}
if ( pfnVerifyConsoleIoHandle
? !pfnVerifyConsoleIoHandle(hHandle)
: GetFileType(hHandle) == FILE_TYPE_UNKNOWN && GetLastError() != NO_ERROR)
return VERR_INVALID_HANDLE;
}
/*
* On Windows 10 and (hopefully) 8.1 we get ERROR_INVALID_FUNCTION with console
* I/O handles and null device handles. We must ignore these just like the
* above invalid handle error.
*/
else if (rc != VERR_INVALID_FUNCTION && rc != VERR_IO_BAD_COMMAND)
return rc;
RT_ZERO(*pObjInfo);
pObjInfo->Attr.enmAdditional = enmAdditionalAttribs;
pObjInfo->Attr.fMode = rtFsModeFromDos(RTFS_DOS_NT_DEVICE, "", 0, 0, 0);
return VINF_SUCCESS;
#else
BY_HANDLE_FILE_INFORMATION Data;
if (!GetFileInformationByHandle(hHandle, &Data))
{
/*
* Console I/O handles make trouble here. On older windows versions they
* end up with ERROR_INVALID_HANDLE when handed to the above API, while on
* more recent ones they cause different errors to appear.
*
* Thus, we must ignore the latter and doubly verify invalid handle claims.
* We use the undocumented VerifyConsoleIoHandle to do this, falling back on
* GetFileType should it not be there.
*/
DWORD dwErr = GetLastError();
if (dwErr == ERROR_INVALID_HANDLE)
{
static PFNVERIFYCONSOLEIOHANDLE s_pfnVerifyConsoleIoHandle = NULL;
static bool volatile s_fInitialized = false;
PFNVERIFYCONSOLEIOHANDLE pfnVerifyConsoleIoHandle;
if (s_fInitialized)
pfnVerifyConsoleIoHandle = s_pfnVerifyConsoleIoHandle;
else
{
pfnVerifyConsoleIoHandle = (PFNVERIFYCONSOLEIOHANDLE)RTLdrGetSystemSymbol("kernel32.dll", "VerifyConsoleIoHandle");
ASMAtomicWriteBool(&s_fInitialized, true);
}
if ( pfnVerifyConsoleIoHandle
? !pfnVerifyConsoleIoHandle(hHandle)
: GetFileType(hHandle) == FILE_TYPE_UNKNOWN && GetLastError() != NO_ERROR)
return VERR_INVALID_HANDLE;
}
/*
* On Windows 10 and (hopefully) 8.1 we get ERROR_INVALID_FUNCTION with console I/O
* handles. We must ignore these just like the above invalid handle error.
*/
else if (dwErr != ERROR_INVALID_FUNCTION)
return RTErrConvertFromWin32(dwErr);
RT_ZERO(Data);
Data.dwFileAttributes = RTFS_DOS_NT_DEVICE;
}
/*
* Setup the returned data.
*/
pObjInfo->cbObject = ((uint64_t)Data.nFileSizeHigh << 32)
| (uint64_t)Data.nFileSizeLow;
pObjInfo->cbAllocated = pObjInfo->cbObject;
Assert(sizeof(uint64_t) == sizeof(Data.ftCreationTime));
RTTimeSpecSetNtTime(&pObjInfo->BirthTime, *(uint64_t *)&Data.ftCreationTime);
RTTimeSpecSetNtTime(&pObjInfo->AccessTime, *(uint64_t *)&Data.ftLastAccessTime);
RTTimeSpecSetNtTime(&pObjInfo->ModificationTime, *(uint64_t *)&Data.ftLastWriteTime);
pObjInfo->ChangeTime = pObjInfo->ModificationTime;
pObjInfo->Attr.fMode = rtFsModeFromDos((Data.dwFileAttributes << RTFS_DOS_SHIFT) & RTFS_DOS_MASK_NT, "", 0,
RTFSMODE_SYMLINK_REPARSE_TAG /* (symlink or not, doesn't usually matter here) */);
/*
* Requested attributes (we cannot provide anything actually).
*/
switch (enmAdditionalAttribs)
{
case RTFSOBJATTRADD_NOTHING:
pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_NOTHING;
break;
case RTFSOBJATTRADD_UNIX:
pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX;
pObjInfo->Attr.u.Unix.uid = ~0U;
pObjInfo->Attr.u.Unix.gid = ~0U;
pObjInfo->Attr.u.Unix.cHardlinks = Data.nNumberOfLinks ? Data.nNumberOfLinks : 1;
pObjInfo->Attr.u.Unix.INodeIdDevice = Data.dwVolumeSerialNumber;
pObjInfo->Attr.u.Unix.INodeId = RT_MAKE_U64(Data.nFileIndexLow, Data.nFileIndexHigh);
pObjInfo->Attr.u.Unix.fFlags = 0;
pObjInfo->Attr.u.Unix.GenerationId = 0;
pObjInfo->Attr.u.Unix.Device = 0;
break;
case RTFSOBJATTRADD_UNIX_OWNER:
pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_OWNER;
pObjInfo->Attr.u.UnixOwner.uid = ~0U;
pObjInfo->Attr.u.UnixOwner.szName[0] = '\0'; /** @todo return something sensible here. */
break;
case RTFSOBJATTRADD_UNIX_GROUP:
pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_GROUP;
pObjInfo->Attr.u.UnixGroup.gid = ~0U;
pObjInfo->Attr.u.UnixGroup.szName[0] = '\0';
break;
case RTFSOBJATTRADD_EASIZE:
pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_EASIZE;
pObjInfo->Attr.u.EASize.cb = 0;
break;
default:
AssertMsgFailed(("Impossible!\n"));
return VERR_INTERNAL_ERROR;
}
return VINF_SUCCESS;
#endif
}
RTR3DECL(int) RTFileSetTimes(RTFILE hFile, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
{
RT_NOREF_PV(pChangeTime); /* Not exposed thru the windows API we're using. */
if (!pAccessTime && !pModificationTime && !pBirthTime)
return VINF_SUCCESS; /* NOP */
FILETIME CreationTimeFT;
PFILETIME pCreationTimeFT = NULL;
if (pBirthTime)
pCreationTimeFT = RTTimeSpecGetNtFileTime(pBirthTime, &CreationTimeFT);
FILETIME LastAccessTimeFT;
PFILETIME pLastAccessTimeFT = NULL;
if (pAccessTime)
pLastAccessTimeFT = RTTimeSpecGetNtFileTime(pAccessTime, &LastAccessTimeFT);
FILETIME LastWriteTimeFT;
PFILETIME pLastWriteTimeFT = NULL;
if (pModificationTime)
pLastWriteTimeFT = RTTimeSpecGetNtFileTime(pModificationTime, &LastWriteTimeFT);
int rc = VINF_SUCCESS;
if (!SetFileTime((HANDLE)RTFileToNative(hFile), pCreationTimeFT, pLastAccessTimeFT, pLastWriteTimeFT))
{
DWORD Err = GetLastError();
rc = RTErrConvertFromWin32(Err);
Log(("RTFileSetTimes(%RTfile, %p, %p, %p, %p): SetFileTime failed with lasterr %d (%Rrc)\n",
hFile, pAccessTime, pModificationTime, pChangeTime, pBirthTime, Err, rc));
}
return rc;
}
#if 0 /* RTFileSetMode is implemented by RTFileSetMode-r3-nt.cpp */
/* This comes from a source file with a different set of system headers (DDK)
* so it can't be declared in a common header, like internal/file.h.
*/
extern int rtFileNativeSetAttributes(HANDLE FileHandle, ULONG FileAttributes);
RTR3DECL(int) RTFileSetMode(RTFILE hFile, RTFMODE fMode)
{
/*
* Normalize the mode and call the API.
*/
fMode = rtFsModeNormalize(fMode, NULL, 0);
if (!rtFsModeIsValid(fMode))
return VERR_INVALID_PARAMETER;
ULONG FileAttributes = (fMode & RTFS_DOS_MASK) >> RTFS_DOS_SHIFT;
int Err = rtFileNativeSetAttributes((HANDLE)hFile, FileAttributes);
if (Err != ERROR_SUCCESS)
{
int rc = RTErrConvertFromWin32(Err);
Log(("RTFileSetMode(%RTfile, %RTfmode): rtFileNativeSetAttributes (0x%08X) failed with err %d (%Rrc)\n",
hFile, fMode, FileAttributes, Err, rc));
return rc;
}
return VINF_SUCCESS;
}
#endif
/* RTFileQueryFsSizes is implemented by ../nt/RTFileQueryFsSizes-nt.cpp */
RTR3DECL(int) RTFileDelete(const char *pszFilename)
{
PRTUTF16 pwszFilename;
int rc = RTPathWinFromUtf8(&pwszFilename, pszFilename, 0 /*fFlags*/);
if (RT_SUCCESS(rc))
{
if (!DeleteFileW(pwszFilename))
rc = RTErrConvertFromWin32(GetLastError());
RTPathWinFree(pwszFilename);
}
return rc;
}
RTDECL(int) RTFileRename(const char *pszSrc, const char *pszDst, unsigned fRename)
{
/*
* Validate input.
*/
AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
AssertMsgReturn(!(fRename & ~RTPATHRENAME_FLAGS_REPLACE), ("%#x\n", fRename), VERR_INVALID_PARAMETER);
/*
* Hand it on to the worker.
*/
int rc = rtPathWin32MoveRename(pszSrc, pszDst,
fRename & RTPATHRENAME_FLAGS_REPLACE ? MOVEFILE_REPLACE_EXISTING : 0,
RTFS_TYPE_FILE);
LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
pszSrc, pszSrc, pszDst, pszDst, fRename, rc));
return rc;
}
RTDECL(int) RTFileMove(const char *pszSrc, const char *pszDst, unsigned fMove)
{
/*
* Validate input.
*/
AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
AssertMsgReturn(!(fMove & ~RTFILEMOVE_FLAGS_REPLACE), ("%#x\n", fMove), VERR_INVALID_PARAMETER);
/*
* Hand it on to the worker.
*/
int rc = rtPathWin32MoveRename(pszSrc, pszDst,
fMove & RTFILEMOVE_FLAGS_REPLACE
? MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING
: MOVEFILE_COPY_ALLOWED,
RTFS_TYPE_FILE);
LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
pszSrc, pszSrc, pszDst, pszDst, fMove, rc));
return rc;
}
|