-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Add symbolic link APIs #54253
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add symbolic link APIs #54253
Changes from 1 commit
Commits
Show all changes
51 commits
Select commit
Hold shift + click to select a range
b63c7b7
ref declarations and src empty definitions
carlossanlop b223304
Implementation for Unix symlinks APIs and cross-platform unit tests.
carlossanlop 2e822fd
Add windows implementation of [sym]link APIs
jozkee 32e196c
Use ValueStringBuilder in ResolveLinkTarget
carlossanlop 8ed2772
Build failure in FileSystemWatcher csproj due to missing new interop …
carlossanlop abbecf0
Fix build failure. Address documentation suggestions.
fc49855
Add missing csproj references to System.Net.Ping.Functional.Tests (pr…
carlossanlop 86cbd19
Move CanCreateSymbolicLinks from FileSystemWatcher one class above, s…
480d3df
Fix some Microsoft.IO.Redist CI failures.
carlossanlop a6cd9da
Fix CI build failures from Net5Compat.Tests
carlossanlop 6952eb7
Clean CanCreateSymbolicLinks for readability. Remove incomplete code.
carlossanlop 797ace5
Support long paths in GetFinalPathNameByHandle
jozkee 8639e3b
Use MS.IO.Redist friendly APIs for marshalling
jozkee 6bb1aa9
Add IsBrowser check to CanCreateSymbolicLinks
carlossanlop 88bcadb
Add more tests and fix some issues in windows
jozkee 8701118
Add path to IO_InconsistentLinkType exception msg
carlossanlop d10e00c
Fix failure in test creating inconsistent file/dir type.
carlossanlop fa5ff40
Fix net48 error
jozkee 6788db7
Address CreateSymbolicLink initial check on Unix to verify pathToTarg…
45392b4
Use RemoteExecutor for a test related to change the current working dir
jozkee 38b6e88
Add missing argument to exception message in MS.IO.Redist
a70cdef
nit: Clean comment on CreateSymbolicLink p/invoke.
cbcf7af
Fix CI bug in Windows Nano where %TEMP% points to "C:\Windows\TEMP" b…
carlossanlop c43664a
Use ALLOW_UNPRIVILEGED_CREATE only on windows versions >= 10.0.14972
jozkee 9460264
Do not use IsWindowsVersionAtLeast since isn't avail in ns2.0
jozkee bbaa35a
Use PrintName (Dos) instead of SubstituteName (NT)
jozkee 7e2eaa9
Fix issues related to server share paths
jozkee 0d4250b
Fix CI issues
jozkee 1a05a56
Address suggestions
jozkee d656aed
Address suggestions
jozkee adcca16
Address suggestions about using PathInternal.IsExtended
jozkee 35165b0
Add more scenarios for "file system entry type is inconsistent with t…
jozkee 9d2694b
Remove duplicated validation checks
jozkee c79df26
Address suggestions for Unix
jozkee fc4241d
ifdef the list of paths used for theories
jozkee 4881f2b
Add tests to verify the limit of followed links
jozkee b377cb0
Fix bug related to follow links limit in Unix
jozkee 496487f
Trim extended prefix when the passed-in path is not extended
jozkee beaf701
Remove helper AssertFullNameEquals since is no longer needed and fix …
jozkee a5986fb
Add a check for versions < win10 build 14972 to fix silent error
jozkee b7ec269
Add Windows limit for ResolveLinkTarget to remarks
jozkee 7f37a86
Remove pipe test
jozkee 3e36f72
Remove lstat from ResolveLinkTarget
jozkee 6f5b99a
Avoid testing the reparse point/soft link limit very precisely
jozkee 2d09f7e
Fix LinkTarget invalidation logic
jozkee 4b5e133
Make returnFinalTarget no longer optional
jozkee 82dc88a
Merge branch 'main' of https://github.com/dotnet/runtime into symlinks
jozkee 48e1af1
Try to fix failing tests found in CI
jozkee 0495f59
Try smaller chains of links
jozkee 40cb737
Avoid using GetTestFilePath in order to correctly compare against the…
jozkee 995ead5
Use chain length of 20 instead of 30, which fails in Win 1809
jozkee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix issues related to server share paths
- Loading branch information
commit 7e2eaa934da42ec449225b28416f9b4844a82a11
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -413,8 +413,9 @@ internal static void CreateSymbolicLink(string path, string pathToTarget, bool i | |
| Path.Join(Path.GetDirectoryName(path), pathToTarget) : pathToTarget; | ||
|
|
||
| Interop.Kernel32.WIN32_FILE_ATTRIBUTE_DATA data = default; | ||
| FillAttributeInfo(pathToTargetFullPath, ref data, returnErrorOnNotFound: false); | ||
| if (data.dwFileAttributes != -1 && | ||
| int errorCode = FillAttributeInfo(pathToTargetFullPath, ref data, returnErrorOnNotFound: true); | ||
| if (errorCode == Interop.Errors.ERROR_SUCCESS && | ||
| data.dwFileAttributes != -1 && | ||
| isDirectory != ((data.dwFileAttributes & Interop.Kernel32.FileAttributes.FILE_ATTRIBUTE_DIRECTORY) != 0)) | ||
| { | ||
| throw new IOException(SR.Format(SR.IO_InconsistentLinkType, path)); | ||
|
|
@@ -430,20 +431,20 @@ internal static void CreateSymbolicLink(string path, string pathToTarget, bool i | |
| { | ||
| string? targetPath = returnFinalTarget ? | ||
| GetFinalLinkTarget(linkPath, isDirectory) : | ||
| GetImmediateLinkTarget(linkPath, isDirectory, throwOnNotFound: true, normalize: true); | ||
| GetImmediateLinkTarget(linkPath, isDirectory, throwOnUnreachable: true, normalize: true); | ||
|
|
||
| return targetPath == null ? null : | ||
| isDirectory ? new DirectoryInfo(targetPath) : new FileInfo(targetPath); | ||
| } | ||
|
|
||
| internal static string? GetLinkTarget(string linkPath, bool isDirectory) | ||
| => GetImmediateLinkTarget(linkPath, isDirectory, throwOnNotFound: false, normalize: false); | ||
| => GetImmediateLinkTarget(linkPath, isDirectory, throwOnUnreachable: false, normalize: false); | ||
|
|
||
| /// <summary> | ||
| /// Gets reparse point information associated to <paramref name="linkPath"/>. | ||
| /// </summary> | ||
| /// <returns>The immediate link target, absolute or relative or null if the file is not a supported link.</returns> | ||
| internal static unsafe string? GetImmediateLinkTarget(string linkPath, bool isDirectory, bool throwOnNotFound, bool normalize) | ||
| internal static unsafe string? GetImmediateLinkTarget(string linkPath, bool isDirectory, bool throwOnUnreachable, bool normalize) | ||
| { | ||
| using SafeFileHandle handle = OpenSafeFileHandle(linkPath, | ||
| Interop.Kernel32.FileOperations.FILE_FLAG_BACKUP_SEMANTICS | | ||
jozkee marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
@@ -452,20 +453,19 @@ internal static void CreateSymbolicLink(string path, string pathToTarget, bool i | |
| if (handle.IsInvalid) | ||
| { | ||
| int error = Marshal.GetLastWin32Error(); | ||
| switch (error) | ||
|
|
||
| if (!throwOnUnreachable && IsPathUnreachableError(error)) | ||
| { | ||
| case Interop.Errors.ERROR_FILE_NOT_FOUND: | ||
| case Interop.Errors.ERROR_PATH_NOT_FOUND: | ||
| if (throwOnNotFound) | ||
| { | ||
| throw Win32Marshal.GetExceptionForWin32Error( | ||
| // File not found doesn't make much sense coming from a directory. | ||
| isDirectory ? Interop.Errors.ERROR_PATH_NOT_FOUND : error, linkPath); | ||
| } | ||
| return null; | ||
| default: | ||
| throw Win32Marshal.GetExceptionForWin32Error(error, linkPath); | ||
| return null; | ||
| } | ||
|
|
||
| // File not found doesn't make much sense coming from a directory. | ||
| if (isDirectory && error == Interop.Errors.ERROR_FILE_NOT_FOUND) | ||
| { | ||
| error = Interop.Errors.ERROR_PATH_NOT_FOUND; | ||
| } | ||
|
|
||
| throw Win32Marshal.GetExceptionForWin32Error(error, linkPath); | ||
| } | ||
|
|
||
| byte[] buffer = ArrayPool<byte>.Shared.Rent(Interop.Kernel32.MAXIMUM_REPARSE_DATA_BUFFER_SIZE); | ||
|
|
@@ -503,9 +503,10 @@ internal static void CreateSymbolicLink(string path, string pathToTarget, bool i | |
| return null; | ||
| } | ||
|
|
||
| // We use PrintName instead of SubstitutneName given that we don't want to return a NT path. | ||
| // We use PrintName instead of SubstitutneName given that we don't want to return a NT path when the link wasn't created with such NT path. | ||
| // Unlike SubstituteName and GetFinalPathNameByHandle(), PrintName doesn't start with a prefix. | ||
| // Another nuance is that SubstituteName does not contain redundant path segments while PrintName does. | ||
| // PrintName can ONLY return a NT path if the link was created explicitly targeting a file/folder in such way. e.g: mklink /D linkName \??\C:\path\to\target. | ||
| int printNameNameOffset = sizeof(Interop.Kernel32.REPARSE_DATA_BUFFER) + rdb.ReparseBufferSymbolicLink.PrintNameOffset; | ||
| int printNameNameLength = rdb.ReparseBufferSymbolicLink.PrintNameLength; | ||
|
|
||
|
|
@@ -548,11 +549,10 @@ internal static void CreateSymbolicLink(string path, string pathToTarget, bool i | |
|
|
||
| if (handle.IsInvalid) | ||
| { | ||
| // If the handle fails with "not found", is becuse the link was broken. | ||
| // We need to fallback to manually traverse the link targets and return the target of the last resolved link. | ||
| // If the handle fails because it is unreachable, is becuse the link was broken. | ||
| // We need to fallback to manually traverse the links and return the target of the last resolved link. | ||
| int error = Marshal.GetLastWin32Error(); | ||
| if (error == Interop.Errors.ERROR_FILE_NOT_FOUND || | ||
| error == Interop.Errors.ERROR_PATH_NOT_FOUND) | ||
| if (IsPathUnreachableError(error)) | ||
| { | ||
| return GetFinalLinkTargetSlow(linkPath); | ||
adamsitnik marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
|
|
@@ -607,13 +607,13 @@ uint GetFinalPathNameByHandle(SafeFileHandle handle, char[] buffer) | |
| { | ||
| // Since all these paths will be passed to CreateFile, which takes a string anyway, it is pointless to use span. | ||
| // I am not sure if it's possible to change CreateFile's param to ROS<char> and avoid all these allocations. | ||
|
||
| string? current = GetImmediateLinkTarget(linkPath, isDirectory, throwOnNotFound: false, normalize: true); | ||
| string? current = GetImmediateLinkTarget(linkPath, isDirectory, throwOnUnreachable: false, normalize: true); | ||
| string? prev = null; | ||
|
|
||
| while (current != null) | ||
| { | ||
| prev = current; | ||
| current = GetImmediateLinkTarget(current, isDirectory, throwOnNotFound: false, normalize: true); | ||
| current = GetImmediateLinkTarget(current, isDirectory, throwOnUnreachable: false, normalize: true); | ||
| } | ||
|
|
||
| return prev; | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.