cifs: Add support for parsing WSL symlinks in version 1 format
Subsystems (2)
PATCH 1/2 cifs: Add support for parsing WSL symlinks in version 1 format
MS-FSCC 2.1.2.7 for IO_REPARSE_TAG_LX_SYMLINK reparse points currently documents only layout version 2 format.
IO_REPARSE_TAG_LX_SYMLINK reparse point buffer of layout version 1 format is documented in the newly released Microsoft WSL source code at github:
https://github.com/microsoft/WSL/blob/2.5.8/test/windows/DrvFsTests.cpp#L775-L815
Difference between version 1 and version 2 is that version 1 stores the symlink target location into data section of the file, but version 2 stores it directly into the reparse point buffer.
This change implements support for parsing WSL symlinks in this layout version 1 format by Linux SMB client and so allow to recognize these type of symlinks like Windows WSL.
--- fs/smb/client/cifsproto.h | 5 ++- fs/smb/client/inode.c | 1 + fs/smb/client/reparse.c | 94 ++++++++++++++++++++++++++++++++++----- fs/smb/common/smb2pdu.h | 5 ++- 4 files changed, 92 insertions(+), 13 deletions(-)
fs/smb/client/cifsproto.h +4 -1
@@ -669,7 +669,10 @@ int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);char *extract_hostname (const char *unc);char *extract_sharename (const char *unc);int parse_reparse_point (struct reparse_data_buffer *buf, -u32 plen,struct cifs_sb_info *cifs_sb, +u32 plen, +unsigned int xid, +struct cifs_tcon *tcon, +struct cifs_sb_info *cifs_sb,const char *full_path,struct cifs_open_info_data *data); int __cifs_sfu_make_node(unsigned int xid, struct inode *inode,
fs/smb/client/inode.c +1 -0
@@ -1170,6 +1170,7 @@ static int reparse_info_to_fattr(struct cifs_open_info_data *data, reparse_buf = server->ops->get_reparse_point_buffer (iov, &reparse_len); rc =parse_reparse_point (reparse_buf, reparse_len, + xid, tcon, cifs_sb, full_path, data);/* * If the reparse point was not handled but it is the
fs/smb/client/reparse.c +84 -10
147 lines not on this page · raw message
fs/smb/common/smb2pdu.h +3 -2
@@ -1567,12 +1567,13 @@ struct reparse_nfs_data_buffer {__u8 DataBuffer[]; } __packed; -/* For IO_REPARSE_TAG_LX_SYMLINK - see MS-FSCC 2.1.2.7 */ +/* For IO_REPARSE_TAG_LX_SYMLINK - see MS-FSCC 2.1.2.7 and +* https://github.com/microsoft/WSL/blob/2.5.8/test/windows/DrvFsTests.cpp#L775-L815 */ struct reparse_wsl_symlink_data_buffer {__le32 ReparseTag;__le16 ReparseDataLength;__u16 Reserved; -__le32 Version;/* Always 2 */ +__le32 Version;/* 1 - stores symlink path in file data section; 2 - stores symlink path in Target[] field */ __u8 Target[];/* Variable Length UTF-8 string without nul-term */ } __packed;
Signature · 1 line
2.20.1
PATCH 2/2 cifs: Add support for creating WSL symlinks in version 1 format
Add a new mount option -o symlink=wsl1 which cause that all newly created symlinks would be of WSL style in layout version 1 format. This type of symlinks is supported by all WSL versions.
Existing mount option -o symlink=wsl will be now an alias to -o symlink=wsl2 which creates symlinks in layour version 2 format.
--- fs/smb/client/cifsglob.h | 9 +++-- fs/smb/client/fs_context.c | 11 ++++-- fs/smb/client/fs_context.h | 3 +- fs/smb/client/link.c | 3 +- fs/smb/client/reparse.c | 73 ++++++++++++++++++++++++++++++++------ 5 files changed, 81 insertions(+), 18 deletions(-)
fs/smb/client/cifsglob.h +6 -3
@@ -189,7 +189,8 @@ enum cifs_symlink_type {CIFS_SYMLINK_TYPE_MFSYMLINKS ,CIFS_SYMLINK_TYPE_SFU ,CIFS_SYMLINK_TYPE_NFS , - CIFS_SYMLINK_TYPE_WSL, +CIFS_SYMLINK_TYPE_WSL1 , + CIFS_SYMLINK_TYPE_WSL2, };static inline const char *cifs_symlink_type_str (enum cifs_symlink_type type)
@@ -207,8 +208,10 @@ static inline const char *cifs_symlink_type_str(enum cifs_symlink_type type)return "sfu" ;case CIFS_SYMLINK_TYPE_NFS :return "nfs" ; -case CIFS_SYMLINK_TYPE_WSL : -return "wsl" ; +case CIFS_SYMLINK_TYPE_WSL1 : +return "wsl1" ; +case CIFS_SYMLINK_TYPE_WSL2 : +return "wsl2" ;default :return "unknown" ; }
fs/smb/client/fs_context.c +8 -3
@@ -377,7 +377,9 @@ static const match_table_t symlink_flavor_tokens = { { Opt_symlink_mfsymlinks, "mfsymlinks" }, { Opt_symlink_sfu, "sfu" }, { Opt_symlink_nfs, "nfs" }, - { Opt_symlink_wsl, "wsl" }, + { Opt_symlink_wsl1, "wsl1" }, + { Opt_symlink_wsl2, "wsl2" }, + { Opt_symlink_wsl2, "wsl" }, /* wsl - alias for wsl2 */ { Opt_symlink_err, NULL }, };
@@ -408,8 +410,11 @@ static int parse_symlink_flavor(struct fs_context *fc, char *value,case Opt_symlink_nfs: ctx->symlink_type =CIFS_SYMLINK_TYPE_NFS ;break ; -case Opt_symlink_wsl: - ctx->symlink_type =CIFS_SYMLINK_TYPE_WSL ; +case Opt_symlink_wsl1: + ctx->symlink_type =CIFS_SYMLINK_TYPE_WSL1 ; +break ; +case Opt_symlink_wsl2: + ctx->symlink_type =CIFS_SYMLINK_TYPE_WSL2 ;break ;default :cifs_errorf (fc,"bad symlink= option: %s\n" , value);
fs/smb/client/fs_context.h +2 -1
@@ -72,7 +72,8 @@ enum cifs_symlink_parm { Opt_symlink_mfsymlinks, Opt_symlink_sfu, Opt_symlink_nfs, - Opt_symlink_wsl, + Opt_symlink_wsl1, + Opt_symlink_wsl2, Opt_symlink_err };
fs/smb/client/link.c +2 -1
@@ -641,7 +641,8 @@ cifs_symlink(struct mnt_idmap *idmap, struct inode *inode,case CIFS_SYMLINK_TYPE_NATIVE :case CIFS_SYMLINK_TYPE_NFS : -case CIFS_SYMLINK_TYPE_WSL : +case CIFS_SYMLINK_TYPE_WSL1 : +case CIFS_SYMLINK_TYPE_WSL2 :if (le32_to_cpu (pTcon->fsAttrInfo.Attributes) &FILE_SUPPORTS_REPARSE_POINTS ) { rc =create_reparse_symlink (xid, inode, direntry, pTcon, full_path, symname);
fs/smb/client/reparse.c +63 -10
132 lines not on this page · raw message
Signature · 1 line
2.20.1
Hello, have you looked at this change?
Quoted 230 lines · On Saturday 12 July 2025 18:14:17 Pali Rohár wrote:
MS-FSCC 2.1.2.7 for
IO_REPARSE_TAG_LX_SYMLINKreparse points currently documents only layout version 2 format.
IO_REPARSE_TAG_LX_SYMLINKreparse point buffer of layout version 1 format is documented in the newly released Microsoft WSL source code at github:
https://github.com/microsoft/WSL/blob/2.5.8/test/windows/DrvFsTests.cpp#L775-L815Difference between version 1 and version 2 is that version 1 stores the symlink target location into data section of the file, but version 2 stores it directly into the reparse point buffer.
This change implements support for parsing WSL symlinks in this layout version 1 format by Linux SMB client and so allow to recognize these type of symlinks like Windows WSL.
Signed-off-by Pali Rohár <[email protected]>--- fs/smb/client/cifsproto.h | 5 ++- fs/smb/client/inode.c | 1 + fs/smb/client/reparse.c | 94 ++++++++++++++++++++++++++++++++++----- fs/smb/common/smb2pdu.h | 5 ++- 4 files changed, 92 insertions(+), 13 deletions(-)fs/smb/client/cifsproto.h +4
-1@@ -669,7 +669,10 @@ int cifs_update_super_prepath(struct cifs_sb_info *cifs_sb, char *prefix);char *extract_hostname (const char *unc);char *extract_sharename (const char *unc);int parse_reparse_point (struct reparse_data_buffer *buf, -u32 plen,struct cifs_sb_info *cifs_sb, +u32 plen, +unsigned int xid, +struct cifs_tcon *tcon, +struct cifs_sb_info *cifs_sb,const char *full_path,struct cifs_open_info_data *data); int __cifs_sfu_make_node(unsigned int xid, struct inode *inode,fs/smb/client/inode.c +1
-0@@ -1170,6 +1170,7 @@ static int reparse_info_to_fattr(struct cifs_open_info_data *data, reparse_buf = server->ops->get_reparse_point_buffer (iov, &reparse_len); rc =parse_reparse_point (reparse_buf, reparse_len, + xid, tcon, cifs_sb, full_path, data);/* * If the reparse point was not handled but it is the fs/smb/client/reparse.c +84
-10@@ -1067,36 +1067,104 @@ static int parse_reparse_native_symlink(struct reparse_symlink_data_buffer *sym, }static int parse_reparse_wsl_symlink (struct reparse_wsl_symlink_data_buffer *buf, +unsigned int xid, +struct cifs_tcon *tcon,struct cifs_sb_info *cifs_sb, +const char *full_path,struct cifs_open_info_data *data) {int len =le16_to_cpu (buf->ReparseDataLength); int data_offset = offsetof(typeof(*buf), Target) - offsetof(typeof(*buf), Version); -int symname_utf8_len; +bool free_symname_utf8 = false; +struct cifs_open_parms oparms; +struct cifs_io_parms io_parms; +unsigned int symname_utf8_len; +char *symname_utf8 =NULL ;__le16 *symname_utf16;int symname_utf16_len; +struct cifs_fid fid; +__u32 oplock; +int buf_type;int rc =0 ; -if (len <= data_offset) { +if (len < data_offset) {cifs_dbg (VFS ,"srv returned malformed wsl symlink buffer\n" ); rc = -EIO ; goto out; } -/* MS-FSCC 2.1.2.7 defines layout of the Target field only for Version 2. */ -if (le32_to_cpu (buf->Version) !=2 ) { +switch (le32_to_cpu (buf->Version)) { +case 1 : +/* +* Layout version 1 stores the symlink target in the data section of +* the file encoded in UTF-8 without trailing null-term byte. +*/ + + oparms =CIFS_OPARMS (cifs_sb, tcon, full_path,FILE_READ_DATA , +FILE_OPEN ,CREATE_NOT_DIR |OPEN_REPARSE_POINT , +ACL_NO_MODE ); + oparms.fid = &fid; + oplock = tcon->ses->server->oplocks ?REQ_OPLOCK :0 ; + rc = tcon->ses->server->ops->open (xid, &oparms, &oplock,NULL ); +if (rc) + goto out; + + free_symname_utf8 = true; + symname_utf8_len =le64_to_cpu (data->fi.EndOfFile); + symname_utf8 =kmalloc (symname_utf8_len,GFP_KERNEL ); +if (!symname_utf8) { + rc = -ENOMEM ; + goto out; + } + + buf_type =CIFS_NO_BUFFER ; + io_parms = (struct cifs_io_parms ) { + .netfid = fid.netfid, + .pid = current->tgid, + .tcon = tcon, + .offset =0 , + .length = symname_utf8_len, + }; + rc = tcon->ses->server->ops->sync_read (xid, &fid, &io_parms, + &symname_utf8_len, + &symname_utf8, + &buf_type); +if (!rc && symname_utf8_len !=le64_to_cpu (data->fi.EndOfFile)) + rc = -EIO ; + + tcon->ses->server->ops->close (xid, tcon, &fid); + +if (rc) { +cifs_dbg (VFS ,"cannot read wsl symlink target location: %d\n" , rc); + goto out; + } + +break ; +case 2 : +/* +* Layout version 2 stores the symlink target in the reparse buffer +* field Target encoded in UTF-8 without trailing null-term byte. +*/ + symname_utf8_len = len - data_offset; + symname_utf8 = buf->Target; +break ; +default :cifs_dbg (VFS ,"srv returned unsupported wsl symlink version %u\n" ,le32_to_cpu (buf->Version)); rc = -EIO ; goto out; } -/* Target for Version 2 is in UTF-8 but without trailing null-term byte */ - symname_utf8_len = len - data_offset; +if (symname_utf8_len ==0 ) { +cifs_dbg (VFS ,"srv returned empty wsl symlink target location\n" ); + rc = -EIO ; + goto out; + } +/* * Check that buffer does not contain null byte * because Linux cannot process symlink with null byte. */ -if (strnlen (buf->Target, symname_utf8_len) != symname_utf8_len) { +if (strnlen (symname_utf8, symname_utf8_len) != symname_utf8_len) {cifs_dbg (VFS ,"srv returned null byte in wsl symlink target location\n" ); rc = -EIO ; goto out;@@ -1106,7 +1174,7 @@ static int parse_reparse_wsl_symlink(struct reparse_wsl_symlink_data_buffer *buf rc = -ENOMEM ; goto out; } - symname_utf16_len =utf8s_to_utf16s (buf->Target, symname_utf8_len, + symname_utf16_len =utf8s_to_utf16s (symname_utf8, symname_utf8_len,UTF16_LITTLE_ENDIAN , (wchar_t *) symname_utf16, symname_utf8_len *2 );if (symname_utf16_len <0 ) {@@ -1126,6 +1194,9 @@ static int parse_reparse_wsl_symlink(struct reparse_wsl_symlink_data_buffer *buf } out: +if (free_symname_utf8) +kfree (symname_utf8); +/* * Convert -EIO to 0. This let lstat() success and * empty data->symlink_target triggers readlink() to fail with -EIO. @@ -1137,7 +1208,10 @@ static int parse_reparse_wsl_symlink(struct reparse_wsl_symlink_data_buffer *buf }int parse_reparse_point (struct reparse_data_buffer *buf, -u32 plen,struct cifs_sb_info *cifs_sb, +u32 plen, +unsigned int xid, +struct cifs_tcon *tcon, +struct cifs_sb_info *cifs_sb,const char *full_path,struct cifs_open_info_data *data) {@@ -1155,7 +1229,7 @@ int parse_reparse_point(struct reparse_data_buffer *buf,case IO_REPARSE_TAG_LX_SYMLINK :return parse_reparse_wsl_symlink ( (struct reparse_wsl_symlink_data_buffer *)buf, - cifs_sb, data); + xid, tcon, cifs_sb, full_path, data);case IO_REPARSE_TAG_AF_UNIX :case IO_REPARSE_TAG_LX_FIFO :case IO_REPARSE_TAG_LX_CHR :fs/smb/common/smb2pdu.h +3
-2@@ -1567,12 +1567,13 @@ struct reparse_nfs_data_buffer {__u8 DataBuffer[]; } __packed; -/* For IO_REPARSE_TAG_LX_SYMLINK - see MS-FSCC 2.1.2.7 */ +/* For IO_REPARSE_TAG_LX_SYMLINK - see MS-FSCC 2.1.2.7 and +* https://github.com/microsoft/WSL/blob/2.5.8/test/windows/DrvFsTests.cpp#L775-L815 */ struct reparse_wsl_symlink_data_buffer {__le32 ReparseTag;__le16 ReparseDataLength;__u16 Reserved; -__le32 Version;/* Always 2 */ +__le32 Version;/* 1 - stores symlink path in file data section; 2 - stores symlink path in Target[] field */ __u8 Target[];/* Variable Length UTF-8 string without nul-term */ } __packed;Signature · 1 line
2.20.1