Skip to contentSkip to conversation

nfsd: Use correct error code when decoding extents

PATCH Superseded Sergey Bashirov 3 participants 7 messages Jun 11, 2025 – Jun 16, 2025

Subsystems (3)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 nfsd: Use correct error code when decoding extents

Update error codes in the block layout driver decoding functions to match the core nfsd code. NFS4ERR_EINVAL means that the server was able to decode the request, but the decoded values are invalid. Use NFS4ERR_BADXDR instead to indicate a decoding error.

---
 fs/nfsd/blocklayoutxdr.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
fs/nfsd/blocklayoutxdr.c +7 -7
index ce78f74715ee..66f75ee70db3 100644
@@ -121,19 +121,19 @@ nfsd4_block_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 
 	if (len < sizeof(u32)) {
 		dprintk("%s: extent array too small: %u\n", __func__, len);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 	len -= sizeof(u32);
 	if (len % PNFS_BLOCK_EXTENT_SIZE) {
 		dprintk("%s: extent array invalid: %u\n", __func__, len);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	nr_iomaps = be32_to_cpup(p++);
 	if (nr_iomaps != len / PNFS_BLOCK_EXTENT_SIZE) {
 		dprintk("%s: extent array size mismatch: %u/%u\n",
 			__func__, len, nr_iomaps);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	iomaps = kcalloc(nr_iomaps, sizeof(*iomaps), GFP_KERNEL);
@@ -181,7 +181,7 @@ nfsd4_block_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 	return nr_iomaps;
 fail:
 	kfree(iomaps);
-	return -EINVAL;
+	return -NFS4ERR_BADXDR;
 }
 
 int
@@ -193,7 +193,7 @@ nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 
 	if (len < sizeof(u32)) {
 		dprintk("%s: extent array too small: %u\n", __func__, len);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	nr_iomaps = be32_to_cpup(p++);
@@ -201,7 +201,7 @@ nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 	if (len != expected) {
 		dprintk("%s: extent array size mismatch: %u/%u\n",
 			__func__, len, expected);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	iomaps = kcalloc(nr_iomaps, sizeof(*iomaps), GFP_KERNEL);
@@ -232,5 +232,5 @@ nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 	return nr_iomaps;
 fail:
 	kfree(iomaps);
-	return -EINVAL;
+	return -NFS4ERR_BADXDR;
 }
Signature · 1 line
2.43.0
#1 lore raw
Quoted 65 lines · Sergey Bashirov

Update error codes in the block layout driver decoding functions to match the core nfsd code. NFS4ERR_EINVAL means that the server was able to decode the request, but the decoded values are invalid. Use NFS4ERR_BADXDR instead to indicate a decoding error.

---
 fs/nfsd/blocklayoutxdr.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
fs/nfsd/blocklayoutxdr.c +6 -6
index ce78f74715ee..66f75ee70db3 100644
@@ -121,19 +121,19 @@ nfsd4_block_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 
 	if (len < sizeof(u32)) {
 		dprintk("%s: extent array too small: %u\n", __func__, len);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 	len -= sizeof(u32);
 	if (len % PNFS_BLOCK_EXTENT_SIZE) {
 		dprintk("%s: extent array invalid: %u\n", __func__, len);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	nr_iomaps = be32_to_cpup(p++);
 	if (nr_iomaps != len / PNFS_BLOCK_EXTENT_SIZE) {
 		dprintk("%s: extent array size mismatch: %u/%u\n",
 			__func__, len, nr_iomaps);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	iomaps = kcalloc(nr_iomaps, sizeof(*iomaps), GFP_KERNEL);
@@ -181,7 +181,7 @@ nfsd4_block_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 	return nr_iomaps;
 fail:
 	kfree(iomaps);
-	return -EINVAL;
+	return -NFS4ERR_BADXDR;
 }
 
 int
@@ -193,7 +193,7 @@ nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 
 	if (len < sizeof(u32)) {
 		dprintk("%s: extent array too small: %u\n", __func__, len);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	nr_iomaps = be32_to_cpup(p++);
@@ -201,7 +201,7 @@ nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 	if (len != expected) {
 		dprintk("%s: extent array size mismatch: %u/%u\n",
 			__func__, len, expected);
-		return -EINVAL;
+		return -NFS4ERR_BADXDR;
 	}
 
 	iomaps = kcalloc(nr_iomaps, sizeof(*iomaps), GFP_KERNEL);

fs/nfsd/blocklayoutxdr.c nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp, · line 236

Quoted 6 lines
fs/nfsd/blocklayoutxdr.c +1 -1
@@ -232,5 +232,5 @@ nfsd4_scsi_decode_layoutupdate(__be32 *p, u32 len, struct iomap **iomapp,
 	return nr_iomaps;
 fail:
 	kfree(iomaps);
-	return -EINVAL;
+	return -NFS4ERR_BADXDR;
 }

nfsd4_block_decode_layoutupdate()'s only caller is nfsd4_block_proc_layoutcommit(), which takes an error return and passes it directly to nfserrno(). If nfserrno() gets a negative NFS4ERR status value, it will bark. Changing only the return values is not enough.

Instead, nfsd4_block_decode_layoutupdate() needs to return /only/ a positive or zero I/O map count or a negative NFS4ERR status code. Then, if nfsd4_block_proc_layoutcommit() sees a negative return value, it converts it to an nfserr by calling cpu_to_be32() on it.

(The -ENOMEM can be converted to -NFS4ERR_DELAY).

It would also help to get a nice kdoc comment added in front of nfsd4_block_decode_layoutupdate() that explains the return value convention.

I see that nfsd4_scsi_decode_layoutupdate() needs the same treatment.

Signature · 1 line
Chuck Lever
#2 lore raw

I also have some doubts about this code:
if (xdr_stream_decode_u64(&xdr, &bex.len))

        return -NFS4ERR_BADXDR;
if (bex.len & (block_size - 1))
        return -NFS4ERR_BADXDR;

The first error code is clear to me, it is all about decoding. But should not we return -NFS4ERR_EINVAL in the second check? On one hand, we encountered an invalid value after successful decoding, but on the other hand, we stopped decoding the extent array, so we can say that this is also a decoding error.

--
Sergey Bashirov

#3 lore raw
Quoted 11 lines · Sergey Bashirov

I also have some doubts about this code:
if (xdr_stream_decode_u64(&xdr, &bex.len))
        return -NFS4ERR_BADXDR;
if (bex.len & (block_size - 1))
        return -NFS4ERR_BADXDR;

The first error code is clear to me, it is all about decoding. But should not we return -NFS4ERR_EINVAL in the second check? On one hand, we encountered an invalid value after successful decoding, but on the other hand, we stopped decoding the extent array, so we can say that this is also a decoding error.

On first read of Section 2.3 of RFC 5663, there's no mandated alignment requirement for bex_length. IMO this is a case where the implementation is deciding that a decoded value is not valid, so NFS4ERR_INVAL might be a better choice here.

Signature · 1 line
Chuck Lever
#4 lore raw
Quoted 13 lines · Chuck Lever
Quoted 11 lines · Sergey Bashirov

I also have some doubts about this code:
if (xdr_stream_decode_u64(&xdr, &bex.len))
        return -NFS4ERR_BADXDR;
if (bex.len & (block_size - 1))
        return -NFS4ERR_BADXDR;

The first error code is clear to me, it is all about decoding. But should not we return -NFS4ERR_EINVAL in the second check? On one hand, we encountered an invalid value after successful decoding, but on the other hand, we stopped decoding the extent array, so we can say that this is also a decoding error.

Quoted 4 lines

On first read of Section 2.3 of RFC 5663, there's no mandated alignment requirement for bex_length. IMO this is a case where the implementation is deciding that a decoded value is not valid, so NFS4ERR_INVAL might be a better choice here.

Section 2.1 of RFC 5663 says:

Clients must be able to perform I/O to the block extents without affecting additional areas of storage (especially important for writes); therefore, extents MUST be aligned to 512-byte boundaries, and writable extents MUST be aligned to the block size used by the NFSv4 server in managing the actual file system (4 kilobytes and 8 kilobytes are common block sizes). This block size is available as the NFSv4.1 layout_blksize attribute.

While it would be nice to state this again in 2.3, the language looks normative enough (TM) to me.

#5 lore raw
Quoted 29 lines · Christoph Hellwig
Quoted 13 lines · Chuck Lever
Quoted 11 lines · Sergey Bashirov

I also have some doubts about this code:
if (xdr_stream_decode_u64(&xdr, &bex.len))
        return -NFS4ERR_BADXDR;
if (bex.len & (block_size - 1))
        return -NFS4ERR_BADXDR;

The first error code is clear to me, it is all about decoding. But should not we return -NFS4ERR_EINVAL in the second check? On one hand, we encountered an invalid value after successful decoding, but on the other hand, we stopped decoding the extent array, so we can say that this is also a decoding error.

Quoted 4 lines

On first read of Section 2.3 of RFC 5663, there's no mandated alignment requirement for bex_length. IMO this is a case where the implementation is deciding that a decoded value is not valid, so NFS4ERR_INVAL might be a better choice here.

Section 2.1 of RFC 5663 says:

Clients must be able to perform I/O to the block extents without affecting additional areas of storage (especially important for writes); therefore, extents MUST be aligned to 512-byte boundaries, and writable extents MUST be aligned to the block size used by the NFSv4 server in managing the actual file system (4 kilobytes and 8 kilobytes are common block sizes). This block size is available as the NFSv4.1 layout_blksize attribute.

Quoted 2 lines

While it would be nice to state this again in 2.3, the language looks normative enough (TM) to me.

No argument from me.

Passing in a non-aligned bex_length still doesn't seem to me to be an XDR issue. Failing with NFS4ERR_INVAL seems like the correct server response for this situation.

Signature · 1 line
Chuck Lever
#6 lore raw
Quoted 3 lines · Chuck Lever

Passing in a non-aligned bex_length still doesn't seem to me to be an XDR issue. Failing with NFS4ERR_INVAL seems like the correct server response for this situation.

Fine with me.