mtd: nand: warn if hamming layout is used with too large ECC
Subsystems (2)
PATCH 1/1 mtd: nand: warn if hamming layout is used with too large ECC
Warn in case a driver uses too large ECC with hamming layout. This is especially helpful since hamming layout is the default layout when using hardware ECC and no specific OOB layout is specified.
--- drivers/mtd/nand/nand_base.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/mtd/nand/nand_base.c +2 -0
@@ -197,6 +197,8 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section,return -EINVAL ; } +WARN_ON (mtd->oobsize - ecc_offset < ecc->total); +if (section ==0 ) { oobregion->offset =2 ; oobregion->length = ecc_offset -2 ;
Signature · 1 line
2.16.1
Quoted 15 lines · On Fri, 9 Feb 2018 00:33:05 +0100 Stefan Agner <[email protected]> wrote:
Warn in case a driver uses too large ECC with hamming layout. This is especially helpful since hamming layout is the default layout when using hardware ECC and no specific OOB layout is specified.
Signed-off-by Stefan Agner <[email protected]>--- drivers/mtd/nand/nand_base.c | 2 ++ 1 file changed, 2 insertions(+)drivers/mtd/nand/nand_base.c +0
-0
drivers/mtd/nand/nand_base.c static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, · line 201
Quoted 5 lines
drivers/mtd/nand/nand_base.c +2
-0@@ -197,6 +197,8 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section,return -EINVAL ; } +WARN_ON (mtd->oobsize - ecc_offset < ecc->total); +
Did you hit this problem? Anyway, if there's a case where the number of ECC bytes does not fit in the space reserved for ECC, there's a bug before this point, and this should be checked at init/probe time.
Quoted 3 lines
drivers/mtd/nand/nand_base.c +0
-0if (section ==0 ) { oobregion->offset =2 ; oobregion->length = ecc_offset -2 ;
Signature · 3 lines
Boris Brezillon, Bootlin (formerly Free Electrons) Embedded Linux and Kernel engineering http://bootlin.com
Quoted 21 lines · Boris Brezillon
Quoted 18 lines · On Fri, 9 Feb 2018 00:33:05 +0100 Stefan Agner <[email protected]> wrote:
Warn in case a driver uses too large ECC with hamming layout. This is especially helpful since hamming layout is the default layout when using hardware ECC and no specific OOB layout is specified.
Signed-off-by Stefan Agner <[email protected]>--- drivers/mtd/nand/nand_base.c | 2 ++ 1 file changed, 2 insertions(+)drivers/mtd/nand/nand_base.c +0
-0@@ -197,6 +197,8 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section,return -EINVAL ; }
Quoted 7 lines
drivers/mtd/nand/nand_base.c static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, · line 201
Quoted 2 lines
drivers/mtd/nand/nand_base.c +2
-0+WARN_ON (mtd->oobsize - ecc_offset < ecc->total); +Did you hit this problem? Anyway, if there's a case where the number of ECC bytes does not fit in the space reserved for ECC, there's a bug before this point, and this should be checked at init/probe time.
Yes, I realized that vf610_nfc.c, which is currently is using the hamming ooblayout. This probably crept in with commit 3cf32d180227 ("mtd: nand: vf610: switch to mtd_ooblayout_ops").
When using 32-bit ECC mode the driver uses 60 bytes out of 64 bytes OOB, so it actually fits into the OOB.
The layout is just bogus for that case. Surprisingly the oobavail calculation ends up being correct, but only because the calculation overflows twice:
mtd_ooblayout_count_bytes calls first with section 0, which results in
38. the second call leads to an overflow ("-36"). mtd_ooblayout_count_bytes then adds 38 to that overflow, which then overflows again to the correct value of overall free bytes of 2... I did not try actually using the free OOB area, I guess this would fail....
Of course the underlying issue that ooblayout for vf610_nfc.c is bogus needs to be fixed, I will send a patch for that.
But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in mtd_ooblayout_count_bytes...
--
Stefan
Quoted 3 lines
Quoted 3 lines
drivers/mtd/nand/nand_base.c +0
-0if (section ==0 ) { oobregion->offset =2 ; oobregion->length = ecc_offset -2 ;
Quoted 47 lines · On Fri, 09 Feb 2018 10:20:37 +0100 Stefan Agner <[email protected]> wrote:
Quoted 21 lines · Boris Brezillon
Quoted 18 lines · On Fri, 9 Feb 2018 00:33:05 +0100 Stefan Agner <[email protected]> wrote:
Warn in case a driver uses too large ECC with hamming layout. This is especially helpful since hamming layout is the default layout when using hardware ECC and no specific OOB layout is specified.
Signed-off-by Stefan Agner <[email protected]>--- drivers/mtd/nand/nand_base.c | 2 ++ 1 file changed, 2 insertions(+)drivers/mtd/nand/nand_base.c +0
-0@@ -197,6 +197,8 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section,return -EINVAL ; }Quoted 7 lines
drivers/mtd/nand/nand_base.c static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, · line 201
Quoted 2 lines
drivers/mtd/nand/nand_base.c +2
-0+WARN_ON (mtd->oobsize - ecc_offset < ecc->total); +Did you hit this problem? Anyway, if there's a case where the number of ECC bytes does not fit in the space reserved for ECC, there's a bug before this point, and this should be checked at init/probe time.
Yes, I realized that
vf610_nfc.c, which is currently is using the hamming ooblayout. This probably crept in with commit3cf32d180227("mtd: nand: vf610: switch tomtd_ooblayout_ops").When using 32-bit ECC mode the driver uses 60 bytes out of 64 bytes OOB, so it actually fits into the OOB.
The layout is just bogus for that case. Surprisingly the oobavail calculation ends up being correct, but only because the calculation overflows twice:
mtd_ooblayout_count_bytescalls first with section 0, which results in
38. the second call leads to an overflow ("-36").mtd_ooblayout_count_bytesthen adds 38 to that overflow, which then overflows again to the correct value of overall free bytes of 2... I did not try actually using the free OOB area, I guess this would fail....
Quoted 8 lines
Of course the underlying issue that ooblayout for
vf610_nfc.cis bogus needs to be fixed, I will send a patch for that.But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in
mtd_ooblayout_count_bytes...
My point was not that we don't need the sanity check, but we probably want that check to happen earlier, for example when we select this layout. Maybe that's not possible though (I didn't look closely at the init sequence).
Quoted 7 lines
--
StefanQuoted 3 lines
Quoted 3 lines
drivers/mtd/nand/nand_base.c +0
-0if (section ==0 ) { oobregion->offset =2 ; oobregion->length = ecc_offset -2 ;
Signature · 3 lines
Boris Brezillon, Bootlin (formerly Free Electrons) Embedded Linux and Kernel engineering http://bootlin.com
Quoted 30 lines · On Fri, 09 Feb 2018 10:20:37 +0100 Stefan Agner <[email protected]> wrote:
Quoted 21 lines · Boris Brezillon
Quoted 18 lines · On Fri, 9 Feb 2018 00:33:05 +0100 Stefan Agner <[email protected]> wrote:
Warn in case a driver uses too large ECC with hamming layout. This is especially helpful since hamming layout is the default layout when using hardware ECC and no specific OOB layout is specified.
Signed-off-by Stefan Agner <[email protected]>--- drivers/mtd/nand/nand_base.c | 2 ++ 1 file changed, 2 insertions(+)drivers/mtd/nand/nand_base.c +0
-0@@ -197,6 +197,8 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section,return -EINVAL ; }Quoted 7 lines
drivers/mtd/nand/nand_base.c static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, · line 201
Quoted 2 lines
drivers/mtd/nand/nand_base.c +2
-0+WARN_ON (mtd->oobsize - ecc_offset < ecc->total); +Did you hit this problem? Anyway, if there's a case where the number of ECC bytes does not fit in the space reserved for ECC, there's a bug before this point, and this should be checked at init/probe time.
Quoted 3 lines
Yes, I realized that
vf610_nfc.c, which is currently is using the hamming ooblayout. This probably crept in with commit3cf32d180227("mtd: nand: vf610: switch tomtd_ooblayout_ops").
Actually, it's bogus since 6a623e076944 ("mtd: nand: add ooblayout for old hamming layout") which was fixing a bug I had introduced with my mtd_ooblayout_ops series :-).
Quoted 5 lines
When using 32-bit ECC mode the driver uses 60 bytes out of 64 bytes OOB, so it actually fits into the OOB.
The layout is just bogus for that case.
Yep, you should use nand_ooblayout_lp_ops, which was the one used by default before 6a623e076944 ("mtd: nand: add ooblayout for old hamming layout").
Quoted 9 lines
Surprisingly the oobavail
calculation ends up being correct, but only because the calculation overflows twice:
mtd_ooblayout_count_bytescalls first with section 0, which results in
38. the second call leads to an overflow ("-36").mtd_ooblayout_count_bytesthen adds 38 to that overflow, which then overflows again to the correct value of overall free bytes of 2... I did not try actually using the free OOB area, I guess this would fail....
That should be fixed to be more robust, indeed.
Quoted 16 lines
Of course the underlying issue that ooblayout for
vf610_nfc.cis bogus needs to be fixed, I will send a patch for that.But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in
mtd_ooblayout_count_bytes...--
StefanQuoted 3 lines
Quoted 3 lines
drivers/mtd/nand/nand_base.c +0
-0if (section ==0 ) { oobregion->offset =2 ; oobregion->length = ecc_offset -2 ;
Signature · 3 lines
Boris Brezillon, Bootlin (formerly Free Electrons) Embedded Linux and Kernel engineering http://bootlin.com
Quoted 42 lines · Boris Brezillon
Quoted 30 lines · On Fri, 09 Feb 2018 10:20:37 +0100 Stefan Agner <[email protected]> wrote:
Quoted 21 lines · Boris Brezillon
Quoted 18 lines · On Fri, 9 Feb 2018 00:33:05 +0100 Stefan Agner <[email protected]> wrote:
Warn in case a driver uses too large ECC with hamming layout. This is especially helpful since hamming layout is the default layout when using hardware ECC and no specific OOB layout is specified.
Signed-off-by Stefan Agner <[email protected]>--- drivers/mtd/nand/nand_base.c | 2 ++ 1 file changed, 2 insertions(+)drivers/mtd/nand/nand_base.c +0
-0@@ -197,6 +197,8 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section,return -EINVAL ; }Quoted 7 lines
drivers/mtd/nand/nand_base.c static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, · line 201
Quoted 2 lines
drivers/mtd/nand/nand_base.c +2
-0+WARN_ON (mtd->oobsize - ecc_offset < ecc->total); +Did you hit this problem? Anyway, if there's a case where the number of ECC bytes does not fit in the space reserved for ECC, there's a bug before this point, and this should be checked at init/probe time.
Quoted 3 lines
Yes, I realized that
vf610_nfc.c, which is currently is using the hamming ooblayout. This probably crept in with commit3cf32d180227("mtd: nand: vf610: switch tomtd_ooblayout_ops").Actually, it's bogus since
6a623e076944("mtd: nand: add ooblayout for old hamming layout") which was fixing a bug I had introduced with mymtd_ooblayout_opsseries :-).Quoted 1 line
Quoted 9 lines
Quoted 4 lines
When using 32-bit ECC mode the driver uses 60 bytes out of 64 bytes OOB, so it actually fits into the OOB.
The layout is just bogus for that case.
Yep, you should use
nand_ooblayout_lp_ops, which was the one used by default before6a623e076944("mtd: nand: add ooblayout for old hamming layout").
Ok, will send a patch for that.
--
Stefan
Quoted 28 lines
Quoted 9 lines
Surprisingly the oobavail
calculation ends up being correct, but only because the calculation overflows twice:
mtd_ooblayout_count_bytescalls first with section 0, which results in
38. the second call leads to an overflow ("-36").mtd_ooblayout_count_bytesthen adds 38 to that overflow, which then overflows again to the correct value of overall free bytes of 2... I did not try actually using the free OOB area, I guess this would fail....That should be fixed to be more robust, indeed.
Quoted 16 lines
Of course the underlying issue that ooblayout for
vf610_nfc.cis bogus needs to be fixed, I will send a patch for that.But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in
mtd_ooblayout_count_bytes...--
StefanQuoted 3 lines
Quoted 3 lines
drivers/mtd/nand/nand_base.c +0
-0if (section ==0 ) { oobregion->offset =2 ; oobregion->length = ecc_offset -2 ;
Quoted 6 lines · On Fri, 09 Feb 2018 10:20:37 +0100 Stefan Agner <[email protected]> wrote:
But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in
mtd_ooblayout_count_bytes...
Something like that should help us detect this unexpected case:
--->8---
drivers/mtd/nand/nand_base.c +0 -0
@@ -201,6 +201,9 @@ static int nand_ooblayout_free_lp_hamming(struct
mtd_info *mtd, int section, oobregion->offset = 2;
oobregion->length = ecc_offset - 2;
} else {
+ if (ecc_offset + ecc->total > mtd->oobsize)
+ return -EINVAL;
+
oobregion->offset = ecc_offset + ecc->total;
oobregion->length = mtd->oobsize - oobregion->offset;
}Quoted 4 lines · Boris Brezillon
Quoted 1 line · On Fri, 09 Feb 2018 10:20:37 +0100 Stefan Agner <[email protected]> wrote:
Quoted 8 lines
Quoted 5 lines
But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in
mtd_ooblayout_count_bytes...Something like that should help us detect this unexpected case:
It is less generic than making length signed and checking for positive length, but fine for me.
--
Stefan
Quoted 15 lines
--->8---
drivers/mtd/nand/nand_base.c +3
-0@@ -201,6 +201,9 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, oobregion->offset = 2; oobregion->length = ecc_offset -2 ; }else { +if (ecc_offset + ecc->total > mtd->oobsize) +return -EINVAL ; + oobregion->offset = ecc_offset + ecc->total; oobregion->length = mtd->oobsize - oobregion->offset; }
Quoted 11 lines · On Fri, 09 Feb 2018 12:55:49 +0100 Stefan Agner <[email protected]> wrote:
Quoted 10 lines · Boris Brezillon
Quoted 6 lines · On Fri, 09 Feb 2018 10:20:37 +0100 Stefan Agner <[email protected]> wrote:
But some kind of sanity check somewhere might be worthwhile, I was a bit surprised that this overflowing happens on a driver in operational use and goes unnoticed. I realize that this patch is not ideal. Maybe making length signed, then we could sanity check in
mtd_ooblayout_count_bytes...
Quoted 5 lines
Quoted 2 lines
Something like that should help us detect this unexpected case:
It is less generic than making length signed and checking for positive length, but fine for me.
It's just easier for callers if they only have to check the return code instead of having to check both the return code and the oobregion fields.
Would you mind modifying your patch accordingly and sending a v2?
Thanks,
Boris
Quoted 19 lines
--
StefanQuoted 15 lines
--->8---
drivers/mtd/nand/nand_base.c +3
-0@@ -201,6 +201,9 @@ static int nand_ooblayout_free_lp_hamming(struct mtd_info *mtd, int section, oobregion->offset = 2; oobregion->length = ecc_offset -2 ; }else { +if (ecc_offset + ecc->total > mtd->oobsize) +return -EINVAL ; + oobregion->offset = ecc_offset + ecc->total; oobregion->length = mtd->oobsize - oobregion->offset; }
Signature · 3 lines
Boris Brezillon, Bootlin (formerly Free Electrons) Embedded Linux and Kernel engineering http://bootlin.com