The P-Bug
From Andrey
| Revision as of 05:22, 3 February 2006 Andrey (Talk | contribs) ← Previous diff |
Current revision Andrey (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| - | + | From: Potekhin, Andrey<br> | |
| - | -----Original Message----- | + | Tuesday, February 01, 2005 10:00 PM<br> |
| - | From: Potekhin, Andrey | + | To: Dev Team<br> |
| - | Sent: Tuesday, February 01, 2005 10:00 PM | + | |
| - | To: Dev Hailey | + | |
| Subject: The P-bug | Subject: The P-bug | ||
| - | |||
| - | ---- | ||
| Dear colleagues, | Dear colleagues, | ||
| - | Once in a while people put their names on things that they discover. | + | Once in a while people put their names on things that they discover - Rorschach spots, Alzheimer's disease, Eiffel tower. Let me introduce '''Potekhin's Bug'''. |
| - | We have Rorschach spots, Alzheimer's disease and Eiffel tower. | + | Let's put this value into database: |
| + | 130 | ||
| - | I would like to introduce | + | Let's retrieve it into a char using a usual ADO call: |
| + | char c = (char)(short)f->Item["MyField"]->Value; | ||
| - | == Potekhin's Bug == | + | In the above code, we need to cast to <code>short</code> since ADO doesn't know how to cast to <code>char</code> directly. Then, we need to cast to <code>char</code> to avoid compiler's warning of a 'possible loss of data'. Since that we are storing values which are not greater than 256, we are sure that no data is lost. |
| - | Put this value into database: | + | Predictably, the retrieved value, as shown by debugger, is not '''130''', but '''-126'''. |
| - | 130 | + | |
| - | Retrieve into char using our usual ADO call: | + | If you think that this is the bug I'm talking about, it is not. This is just a usual signed/unsigned issue. Since c is declared as a (signed) <code>char</code>, the moment the 1 hits its upper bit it becomes a negative value. This is not a bug, this is how it supposed to be. The bits are all the same. It is still '''130''' under the hood. Let's continue. |
| - | char c = (char)(short)f->Item["MyField"]->Value; | + | |
| - | (We need to cast to short since ADO doesn't know how to cast to char directly. Then we need to cast to char to avoid compiler's warning of 'possible loss of data'. Supposed that we are storing values up to 256, we are sure that no data will be lost.) | + | Retrieve the same value as an integer: |
| + | int i = (short)f->Item["MyField"]->Value; | ||
| - | Unfortunately, the retrieved value, as shown by debugger, is not 130, but -126. | + | As you probably guessed, this time the debugger shows '''130'''. |
| - | If you think that this is the bug I'm talking about, it is not. You are right, this is just our usual signed/unsigned issue. Since c is declared as a (signed) char, the moment the 1 hits its upper bit it becomes a negative value. This is not a bug - this is how it supposed to be. Bits are all the same. It is still 130 'under the hood'. But keep reading. | + | === Now, the question: what do you think will be the result of this code: === |
| - | + | ||
| - | Retrieve same value as an int: | + | |
| - | int i = (short)f->Item["MyField"]->Value; | + | |
| - | + | ||
| - | You guessed correctly, this time the debugger shows 130. | + | |
| - | + | ||
| - | == Now, what do you think of this code: == | + | |
| <pre> | <pre> | ||
| if (c == i) | if (c == i) | ||
| { | { | ||
| - | AfxMessageBox("F-word"); | + | AfxMessageBox("Heaven"); |
| } | } | ||
| else | else | ||
| { | { | ||
| - | AfxMessageBox("Marijuana"); | + | AfxMessageBox("Hell"); |
| } | } | ||
| </pre> | </pre> | ||
| - | Which message will we get? On the one hand, this is -126 vs. 130. On the other: | + | On the one hand, this is a case of '''-126''' vs. '''130'''. On the other, we know that: |
| - | - Both values have same bits - 10000010, read from the same database field. | + | - '''Both values have the same bits''' - 10000010, which are read from the same database field. |
| - | - Both are signed values, so no signed/unsigned mismatch here. | + | - '''Both values are signed values''', so there is no signed/unsigned mismatch. |
| - | - When evaluating the expression, both values are converted to same type, int. So when compared, they are of same size. | + | - When evaluating the expression, both values are implicitly converted to same type, '''int'''. So, when compared, they '''are of same size'''. In other words, compiler sees it as <code>if ((int)c == i)</code>. |
| - | + | ||
| - | Which message will you see? I have to tell you. You're getting the else branch. | + | |
| - | + | ||
| - | This is what we call Potekhin's bug. | + | |
| + | So, which message will you see? I'll have to tell you. Despite these assumptions, you'll be getting the else branch. This is what we call Potekhin's bug. | ||
| == Explanation of the trick == | == Explanation of the trick == | ||
| - | You may say, of course, 130 is not -126, period, that's why they don't match. But it does not explain how we end up with such results. I only learned why after looking at bit values in debugger. Compare: | + | One may say, of course, '''130''' is not '''-126''', that's why they don't match. However, this does not explain how did we end up with such results. Here's the explanation. Compare: |
| Before conversion to int: | Before conversion to int: | ||
| - | (int) 130 == 10000010 | + | (int) 130 == 10000010 |
| - | (char) -126 == 10000010 | + | (char) -126 == 10000010 |
| After conversion to int: | After conversion to int: | ||
| - | (int) 130 == 10000010 | + | (int) 130 == 10000010 |
| - | (int) -126 == 11111111111111111111111110000010 | + | (int) -126 == 11111111111111111111111110000010 |
| When a char gets converted, its negative bit gets propagated all the way to the left. | When a char gets converted, its negative bit gets propagated all the way to the left. | ||
| - | Well, I knew it. Kind of. I knew that it gets propagated. The problem is, I didn't realize that it could lead to scenarios like the described above. | + | Well, I knew it. Kind of. I knew that it gets propagated. The problem is, I didn't realize that it could lead to scenarios like one described above. |
| + | |||
| + | Conclusions? Same old rule. Never use a signed char to store anything above 128. Or if you do, don't compare it to an integer :) | ||
| + | |||
| - | Conclusion? Same old rule. Never use a signed char to store anything above 128. Or if you do, don't compare it then to an int... | + | '''[[Main_Page|To Main Page]]''' |
Current revision
From: Potekhin, Andrey
Tuesday, February 01, 2005 10:00 PM
To: Dev Team
Subject: The P-bug
Dear colleagues,
Once in a while people put their names on things that they discover - Rorschach spots, Alzheimer's disease, Eiffel tower. Let me introduce Potekhin's Bug.
Let's put this value into database:
130
Let's retrieve it into a char using a usual ADO call:
char c = (char)(short)f->Item["MyField"]->Value;
In the above code, we need to cast to short since ADO doesn't know how to cast to char directly. Then, we need to cast to char to avoid compiler's warning of a 'possible loss of data'. Since that we are storing values which are not greater than 256, we are sure that no data is lost.
Predictably, the retrieved value, as shown by debugger, is not 130, but -126.
If you think that this is the bug I'm talking about, it is not. This is just a usual signed/unsigned issue. Since c is declared as a (signed) char, the moment the 1 hits its upper bit it becomes a negative value. This is not a bug, this is how it supposed to be. The bits are all the same. It is still 130 under the hood. Let's continue.
Retrieve the same value as an integer:
int i = (short)f->Item["MyField"]->Value;
As you probably guessed, this time the debugger shows 130.
Now, the question: what do you think will be the result of this code:
if (c == i)
{
AfxMessageBox("Heaven");
}
else
{
AfxMessageBox("Hell");
}
On the one hand, this is a case of -126 vs. 130. On the other, we know that:
- Both values have the same bits - 10000010, which are read from the same database field.
- Both values are signed values, so there is no signed/unsigned mismatch.
- When evaluating the expression, both values are implicitly converted to same type, int. So, when compared, they are of same size. In other words, compiler sees it as if ((int)c == i).
So, which message will you see? I'll have to tell you. Despite these assumptions, you'll be getting the else branch. This is what we call Potekhin's bug.
Explanation of the trick
One may say, of course, 130 is not -126, that's why they don't match. However, this does not explain how did we end up with such results. Here's the explanation. Compare:
Before conversion to int:
(int) 130 == 10000010 (char) -126 == 10000010
After conversion to int:
(int) 130 == 10000010 (int) -126 == 11111111111111111111111110000010
When a char gets converted, its negative bit gets propagated all the way to the left.
Well, I knew it. Kind of. I knew that it gets propagated. The problem is, I didn't realize that it could lead to scenarios like one described above.
Conclusions? Same old rule. Never use a signed char to store anything above 128. Or if you do, don't compare it to an integer :)
