Skip to content

Commit

Permalink
Merge branch 'safehandle_filestatus' of https://github.com/tmds/runtime…
Browse files Browse the repository at this point in the history 
… into tmds-safehandle_filestatus
  • Loading branch information
@deeprobin
deeprobin committed Feb 1, 2022
2 parents d5bb271 + b2eec67 commit 3e2e401
Show file tree
Hide file tree
Showing 10 changed files with 178 additions and 259 deletions.
3 changes: 3 additions & 0 deletions src/libraries/System.Private.CoreLib/src/Resources/Strings.resx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1053,6 +1053,9 @@
<data name="Argument_HasToBeArrayClass" xml:space="preserve">
<value>Must be an array type.</value>
</data>
<data name="Arg_HandleHasNoPath" xml:space="preserve">
<value>The handle has no associated path.</value>
</data>
<data name="Argument_IdnBadBidi" xml:space="preserve">
<value>Left to right characters may not be mixed with right to left characters in IDN labels.</value>
</data>
Expand Down
22 changes: 16 additions & 6 deletions src/libraries/System.Private.CoreLib/src/System/IO/FileStatus.SetTimes.OSX.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,19 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Runtime.InteropServices;
using Microsoft.Win32.SafeHandles;

namespace System.IO
{
internal partial struct FileStatus
{
internal void SetCreationTime(string path, DateTimeOffset time, bool asDirectory)
=> SetCreationTime(handle: null, path, time, asDirectory);

internal void SetCreationTime(SafeFileHandle handle, DateTimeOffset time, bool asDirectory)
=> SetCreationTime(handle, handle.Path, time, asDirectory);

private void SetCreationTime(SafeFileHandle? handle, string path, DateTimeOffset time, bool asDirectory)
{
// Try to set the attribute on the file system entry using setattrlist,
// if we get ENOTSUP then it means that "The volume does not support
Expand All @@ -19,23 +26,23 @@ internal void SetCreationTime(string path, DateTimeOffset time, bool asDirectory
// great care.
long seconds = time.ToUnixTimeSeconds();
long nanoseconds = UnixTimeSecondsToNanoseconds(time, seconds);
Interop.Error error = SetCreationTimeCore(path, seconds, nanoseconds);
Interop.Error error = SetCreationTimeCore(handle, path, seconds, nanoseconds);

if (error == Interop.Error.SUCCESS)
{
InvalidateCaches();
}
else if (error == Interop.Error.ENOTSUP)
{
SetAccessOrWriteTimeCore(path, time, isAccessTime: false, checkCreationTime: false, asDirectory);
SetAccessOrWriteTimeCore(handle, path, time, isAccessTime: false, checkCreationTime: false, asDirectory);
}
else
{
Interop.CheckIo(error, path, asDirectory);
}
}

private unsafe Interop.Error SetCreationTimeCore(string path, long seconds, long nanoseconds)
private unsafe Interop.Error SetCreationTimeCore(SafeFileHandle? handle, string path, long seconds, long nanoseconds)
{
Interop.Sys.TimeSpec timeSpec = default;

Expand All @@ -46,15 +53,18 @@ private unsafe Interop.Error SetCreationTimeCore(string path, long seconds, long
attrList.bitmapCount = Interop.libc.AttrList.ATTR_BIT_MAP_COUNT;
attrList.commonAttr = Interop.libc.AttrList.ATTR_CMN_CRTIME;

// Follow links when using SafeFileHandle API.
int flags = handle is null ? new CULong(Interop.libc.FSOPT_NOFOLLOW) : 0;

Interop.Error error =
Interop.libc.setattrlist(path, &attrList, &timeSpec, sizeof(Interop.Sys.TimeSpec), new CULong(Interop.libc.FSOPT_NOFOLLOW)) == 0 ?
Interop.libc.setattrlist(path, &attrList, &timeSpec, sizeof(Interop.Sys.TimeSpec), flags) == 0 ?
Interop.Error.SUCCESS :
Interop.Sys.GetLastErrorInfo().Error;

return error;
}

private void SetAccessOrWriteTime(string path, DateTimeOffset time, bool isAccessTime, bool asDirectory) =>
SetAccessOrWriteTimeCore(path, time, isAccessTime, checkCreationTime: true, asDirectory);
private void SetAccessOrWriteTime(SafeFileHandle? handle, string path, DateTimeOffset time, bool isAccessTime, bool asDirectory) =>
SetAccessOrWriteTimeCore(handle, path, time, isAccessTime, checkCreationTime: true, asDirectory);
}
}
10 changes: 7 additions & 3 deletions src/libraries/System.Private.CoreLib/src/System/IO/FileStatus.SetTimes.OtherUnix.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System.Runtime.InteropServices;
using Microsoft.Win32.SafeHandles;

namespace System.IO
{
Expand All @@ -10,11 +11,14 @@ internal partial struct FileStatus
internal void SetCreationTime(string path, DateTimeOffset time, bool asDirectory) =>
SetLastWriteTime(path, time, asDirectory);

private void SetAccessOrWriteTime(string path, DateTimeOffset time, bool isAccessTime, bool asDirectory) =>
SetAccessOrWriteTimeCore(path, time, isAccessTime, checkCreationTime: false, asDirectory);
internal void SetCreationTime(SafeFileHandle handle, DateTimeOffset time, bool asDirectory) =>
SetLastWriteTime(handle, time, asDirectory);

private void SetAccessOrWriteTime(SafeFileHandle? handle, string path, DateTimeOffset time, bool isAccessTime, bool asDirectory) =>
SetAccessOrWriteTimeCore(handle, path, time, isAccessTime, checkCreationTime: false, asDirectory);

// This is not used on these platforms, but is needed for source compat
private Interop.Error SetCreationTimeCore(string path, long seconds, long nanoseconds) =>
private Interop.Error SetCreationTimeCore(SafeFileHandle? handle, string path, long seconds, long nanoseconds) =>
throw new InvalidOperationException();
}
}
136 changes: 107 additions & 29 deletions src/libraries/System.Private.CoreLib/src/System/IO/FileStatus.Unix.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

using System.Diagnostics;
using System.Runtime.InteropServices;
using Microsoft.Win32.SafeHandles;

namespace System.IO
{
Expand Down Expand Up @@ -180,8 +181,18 @@ internal bool IsSymbolicLink(ReadOnlySpan<char> path, bool continueOnError = fal
}

internal FileAttributes GetAttributes(ReadOnlySpan<char> path, ReadOnlySpan<char> fileName, bool continueOnError = false)
=> GetAttributes(handle: null, path, fileName, continueOnError);

internal FileAttributes GetAttributes(SafeFileHandle handle, bool continueOnError = false)
{
EnsureCachesInitialized(path, continueOnError);
ReadOnlySpan<char> path = handle.Path;
ReadOnlySpan<char> fileName = Path.GetFileName(path);
return GetAttributes(handle, path, fileName, continueOnError);
}

private FileAttributes GetAttributes(SafeFileHandle? handle, ReadOnlySpan<char> path, ReadOnlySpan<char> fileName, bool continueOnError = false)
{
EnsureCachesInitialized(handle, path, continueOnError);

if (!EntryExists)
return (FileAttributes)(-1);
Expand All @@ -204,6 +215,12 @@ internal FileAttributes GetAttributes(ReadOnlySpan<char> path, ReadOnlySpan<char
}

internal void SetAttributes(string path, FileAttributes attributes, bool asDirectory)
=> SetAttributes(handle: null, path, attributes, asDirectory);

internal void SetAttributes(SafeFileHandle handle, FileAttributes attributes, bool asDirectory)
=> SetAttributes(handle, GetHandlePath(handle), attributes, asDirectory);

private void SetAttributes(SafeFileHandle? handle, string path, FileAttributes attributes, bool asDirectory)
{
// Validate that only flags from the attribute are being provided. This is an
// approximation for the validation done by the Win32 function.
Expand All @@ -220,22 +237,21 @@ internal void SetAttributes(string path, FileAttributes attributes, bool asDirec
throw new ArgumentException(SR.Arg_InvalidFileAttrs, "Attributes");
}

EnsureCachesInitialized(path);
EnsureCachesInitialized(handle, path);

if (!EntryExists)
FileSystemInfo.ThrowNotFound(path);

if (Interop.Sys.CanSetHiddenFlag)
{
if ((attributes & FileAttributes.Hidden) != 0 && (_fileCache.UserFlags & (uint)Interop.Sys.UserFlags.UF_HIDDEN) == 0)
{
// If Hidden flag is set and cached file status does not have the flag set then set it
Interop.CheckIo(Interop.Sys.LChflags(path, (_fileCache.UserFlags | (uint)Interop.Sys.UserFlags.UF_HIDDEN)), path, asDirectory);
}
else if (HasHiddenFlag)
bool hidden = (attributes & FileAttributes.Hidden) != 0;
if (hidden ^ HasHiddenFlag)
{
// If Hidden flag is not set and cached file status does have the flag set then remove it
Interop.CheckIo(Interop.Sys.LChflags(path, (_fileCache.UserFlags & ~(uint)Interop.Sys.UserFlags.UF_HIDDEN)), path, asDirectory);
uint flags = hidden ? _fileCache.UserFlags | (uint)Interop.Sys.UserFlags.UF_HIDDEN :
_fileCache.UserFlags & ~(uint)Interop.Sys.UserFlags.UF_HIDDEN;
int rv = handle is not null ? Interop.Sys.FChflags(handle, flags) :
Interop.Sys.LChflags(path!, flags);
Interop.CheckIo(rv, path, asDirectory);
}
}

Expand All @@ -256,7 +272,9 @@ internal void SetAttributes(string path, FileAttributes attributes, bool asDirec
// Change the permissions on the file
if (newMode != _fileCache.Mode)
{
Interop.CheckIo(Interop.Sys.ChMod(path, newMode), path, asDirectory);
int rv = handle is not null ? Interop.Sys.FChMod(handle, newMode) :
Interop.Sys.ChMod(path!, newMode);
Interop.CheckIo(rv, path, asDirectory);
}

InvalidateCaches();
Expand All @@ -269,8 +287,14 @@ internal bool GetExists(ReadOnlySpan<char> path, bool asDirectory)
}

internal DateTimeOffset GetCreationTime(ReadOnlySpan<char> path, bool continueOnError = false)
=> GetCreationTime(handle: null, path, continueOnError);

internal DateTimeOffset GetCreationTime(SafeFileHandle handle, bool continueOnError = false)
=> GetCreationTime(handle, GetHandlePath(handle), continueOnError);

private DateTimeOffset GetCreationTime(SafeFileHandle? handle, ReadOnlySpan<char> path, bool continueOnError = false)
{
EnsureCachesInitialized(path, continueOnError);
EnsureCachesInitialized(handle, path, continueOnError);

if (!EntryExists)
return new DateTimeOffset(DateTime.FromFileTimeUtc(0));
Expand All @@ -287,8 +311,14 @@ internal DateTimeOffset GetCreationTime(ReadOnlySpan<char> path, bool continueOn
}

internal DateTimeOffset GetLastAccessTime(ReadOnlySpan<char> path, bool continueOnError = false)
=> GetLastAccessTime(handle: null, path, continueOnError);

internal DateTimeOffset GetLastAccessTime(SafeFileHandle handle, bool continueOnError = false)
=> GetLastAccessTime(handle, handle.Path, continueOnError);

private DateTimeOffset GetLastAccessTime(SafeFileHandle? handle, ReadOnlySpan<char> path, bool continueOnError = false)
{
EnsureCachesInitialized(path, continueOnError);
EnsureCachesInitialized(handle, path, continueOnError);

if (!EntryExists)
return new DateTimeOffset(DateTime.FromFileTimeUtc(0));
Expand All @@ -297,11 +327,23 @@ internal DateTimeOffset GetLastAccessTime(ReadOnlySpan<char> path, bool continue
}

internal void SetLastAccessTime(string path, DateTimeOffset time, bool asDirectory)
=> SetAccessOrWriteTime(path, time, isAccessTime: true, asDirectory);
=> SetLastAccessTime(handle: null, path, time, asDirectory);

internal void SetLastAccessTime(SafeFileHandle handle, DateTimeOffset time, bool asDirectory)
=> SetLastAccessTime(handle, GetHandlePath(handle), time, asDirectory);

private void SetLastAccessTime(SafeFileHandle? handle, string path, DateTimeOffset time, bool asDirectory)
=> SetAccessOrWriteTime(handle, path, time, isAccessTime: true, asDirectory);

internal DateTimeOffset GetLastWriteTime(ReadOnlySpan<char> path, bool continueOnError = false)
=> GetLastWriteTime(handle: null, path, continueOnError);

internal DateTimeOffset GetLastWriteTime(SafeFileHandle handle, bool continueOnError = false)
=> GetLastWriteTime(handle, handle.Path, continueOnError);

private DateTimeOffset GetLastWriteTime(SafeFileHandle? handle, ReadOnlySpan<char> path, bool continueOnError = false)
{
EnsureCachesInitialized(path, continueOnError);
EnsureCachesInitialized(handle, path, continueOnError);

if (!EntryExists)
return new DateTimeOffset(DateTime.FromFileTimeUtc(0));
Expand All @@ -310,14 +352,20 @@ internal DateTimeOffset GetLastWriteTime(ReadOnlySpan<char> path, bool continueO
}

internal void SetLastWriteTime(string path, DateTimeOffset time, bool asDirectory)
=> SetAccessOrWriteTime(path, time, isAccessTime: false, asDirectory);
=> SetLastWriteTime(handle: null, path, time, asDirectory);

internal void SetLastWriteTime(SafeFileHandle handle, DateTimeOffset time, bool asDirectory)
=> SetLastWriteTime(handle, GetHandlePath(handle), time, asDirectory);

internal void SetLastWriteTime(SafeFileHandle? handle, string path, DateTimeOffset time, bool asDirectory)
=> SetAccessOrWriteTime(handle, path, time, isAccessTime: false, asDirectory);

private DateTimeOffset UnixTimeToDateTimeOffset(long seconds, long nanoseconds)
{
return DateTimeOffset.FromUnixTimeSeconds(seconds).AddTicks(nanoseconds / NanosecondsPerTick);
}

private unsafe void SetAccessOrWriteTimeCore(string path, DateTimeOffset time, bool isAccessTime, bool checkCreationTime, bool asDirectory)
private unsafe void SetAccessOrWriteTimeCore(SafeFileHandle? handle, string path, DateTimeOffset time, bool isAccessTime, bool checkCreationTime, bool asDirectory)
{
// This api is used to set creation time on non OSX platforms, and as a fallback for OSX platforms.
// The reason why we use it to set 'creation time' is the below comment:
Expand All @@ -333,7 +381,7 @@ private unsafe void SetAccessOrWriteTimeCore(string path, DateTimeOffset time, b

// force a refresh so that we have an up-to-date times for values not being overwritten
InvalidateCaches();
EnsureCachesInitialized(path);
EnsureCachesInitialized(handle, path);

if (!EntryExists)
FileSystemInfo.ThrowNotFound(path);
Expand Down Expand Up @@ -365,7 +413,9 @@ private unsafe void SetAccessOrWriteTimeCore(string path, DateTimeOffset time, b
buf[1].TvNsec = nanoseconds;
}
#endif
Interop.CheckIo(Interop.Sys.UTimensat(path, buf), path, asDirectory);
int rv = handle is not null ? Interop.Sys.FUTimens(handle, buf) :
Interop.Sys.UTimensat(path!, buf);
Interop.CheckIo(rv, path, asDirectory);

// On OSX-like platforms, when the modification time is less than the creation time (including
// when the modification time is already less than but access time is being set), the creation
Expand All @@ -382,7 +432,7 @@ private unsafe void SetAccessOrWriteTimeCore(string path, DateTimeOffset time, b

if (updateCreationTime)
{
Interop.Error error = SetCreationTimeCore(path, _fileCache.BirthTime, _fileCache.BirthTimeNsec);
Interop.Error error = SetCreationTimeCore(handle, path, _fileCache.BirthTime, _fileCache.BirthTimeNsec);
if (error != Interop.Error.SUCCESS && error != Interop.Error.ENOTSUP)
{
Interop.CheckIo(error, path, asDirectory);
Expand All @@ -399,17 +449,27 @@ internal long GetLength(ReadOnlySpan<char> path, bool continueOnError = false)
return EntryExists ? _fileCache.Size : 0;
}

internal void RefreshCaches(ReadOnlySpan<char> path)
=> RefreshCaches(handle: null, path);

// Tries to refresh the lstat cache (_fileCache).
// This method should not throw. Instead, we store the results, and we will throw when the user attempts to access any of the properties when there was a failure
internal void RefreshCaches(ReadOnlySpan<char> path)
internal void RefreshCaches(SafeFileHandle? handle, ReadOnlySpan<char> path)
{
path = Path.TrimEndingDirectorySeparator(path);

#if !TARGET_BROWSER
_isReadOnlyCache = -1;
#endif
int rv;
if (handle is not null)
{
rv = Interop.Sys.FStat(handle, out _fileCache);
}
else
{
path = Path.TrimEndingDirectorySeparator(path);
rv = Interop.Sys.LStat(path, out _fileCache);
}

int rv = Interop.Sys.LStat(path, out _fileCache);
if (rv < 0)
{
Interop.ErrorInfo errorInfo = Interop.Sys.GetLastErrorInfo();
Expand All @@ -431,20 +491,24 @@ internal void RefreshCaches(ReadOnlySpan<char> path)
// Check if the main path is a directory, or a link to a directory.
int fileType = _fileCache.Mode & Interop.Sys.FileTypes.S_IFMT;
bool isDirectory = fileType == Interop.Sys.FileTypes.S_IFDIR ||
(fileType == Interop.Sys.FileTypes.S_IFLNK
&& Interop.Sys.Stat(path, out Interop.Sys.FileStatus target) == 0
&& (target.Mode & Interop.Sys.FileTypes.S_IFMT) == Interop.Sys.FileTypes.S_IFDIR);
(handle is null && // Don't follow links for SafeHandle APIs.
fileType == Interop.Sys.FileTypes.S_IFLNK &&
Interop.Sys.Stat(path, out Interop.Sys.FileStatus target) == 0 &&
(target.Mode & Interop.Sys.FileTypes.S_IFMT) == Interop.Sys.FileTypes.S_IFDIR);

_state = isDirectory ? InitializedExistsDir : InitializedExistsFile;
}

internal void EnsureCachesInitialized(ReadOnlySpan<char> path, bool continueOnError = false)
=> EnsureCachesInitialized(handle: null, path, continueOnError);

// Checks if the file cache is uninitialized and refreshes it's value.
// If it failed, and continueOnError is set to true, this method will throw.
internal void EnsureCachesInitialized(ReadOnlySpan<char> path, bool continueOnError = false)
internal void EnsureCachesInitialized(SafeFileHandle? handle, ReadOnlySpan<char> path, bool continueOnError = false)
{
if (_state == Uninitialized)
{
RefreshCaches(path);
RefreshCaches(handle, path);
}

if (!continueOnError)
Expand All @@ -471,5 +535,19 @@ private static long UnixTimeSecondsToNanoseconds(DateTimeOffset time, long secon
const long TicksPerSecond = TicksPerMillisecond * 1000;
return (time.UtcDateTime.Ticks - DateTimeOffset.UnixEpoch.Ticks - seconds * TicksPerSecond) * NanosecondsPerTick;
}

private static string GetHandlePath(SafeFileHandle handle)
{
if (handle.Path is null)
{
ThrowHandleHasNoPath();
}
return handle.Path!;

static void ThrowHandleHasNoPath()
{
throw new ArgumentException(SR.Arg_HandleHasNoPath);
}
}
}
}
Loading

0 comments on commit 3e2e401

Please sign in to comment.