git.sesse.net Git - hamming/blob - hamming32.c

   1 #include <stdio.h>
   2
   3 #define DATA_BITS    26
   4 #define PARITY_BITS  6
   5 #define EXTRA_BIT_POSITION (PARITY_BITS - 1)
   6 #define CODE_BITS    (DATA_BITS + PARITY_BITS)
   7 #define NUM_DATA_WORDS (1 << DATA_BITS)
   8
   9 /*
  10  * Needed since we store all the parity at the end of the word, not at the expected
  11  * power-of-two bit positions.
  12  */
  13 unsigned char permutation_table[CODE_BITS] = {
  14         0, 5, 4, 31, 3, 30, 29, 28, 2, 27, 26, 25, 24, 23, 22, 21, 1, 20, 19, 18, 17, 16, 15, 14, 13, 12, 11, 10, 9, 8, 7, 6
  15 };
  16
  17 unsigned find_parity_32(unsigned data)
  18 {
  19         data = (data >> 16) ^ data;
  20         data = (data >> 8) ^ data;
  21         data = (data >> 4) ^ data;
  22         data = (data >> 2) ^ data;
  23         data = (data >> 1) ^ data;
  24         return (data & 1);
  25 }
  26
  27 unsigned generate_parity(unsigned data)
  28 {
  29         unsigned parity1 = find_parity_32(data & 0x036ad555);
  30         unsigned parity2 = find_parity_32(data & 0x02d9b333);
  31         unsigned parity3 = find_parity_32(data & 0x01c78f0f);
  32         unsigned parity4 = find_parity_32(data & 0x003f80ff);
  33         unsigned parity5 = find_parity_32(data & 0x00007fff);
  34         unsigned parity6 = find_parity_32(data & 0x03b4e996);
  35
  36         return parity6 | (parity5 << 1) | (parity4 << 2) | (parity3 << 3) | (parity2 << 4) | (parity1 << 5);
  37 }
  38
  39 unsigned make_codeword(unsigned data)
  40 {
  41         return (data << PARITY_BITS) | generate_parity(data);
  42 }
  43
  44 /* can detect all single or double bit errors */
  45 int has_error(unsigned code)
  46 {
  47         unsigned data = code >> PARITY_BITS;
  48         unsigned parity = code & ((1 << PARITY_BITS) - 1);
  49
  50         return (generate_parity(data) != parity);
  51 }
  52
  53 int has_double_error(unsigned code)
  54 {
  55         unsigned parity_diff = generate_parity(code >> PARITY_BITS) ^ code;
  56         return (parity_diff & ((1 << PARITY_BITS) - 1)) && !find_parity_32(code);
  57 }
  58
  59 /* Correct any single-bit error -- assumes there are no double-bit errors */
  60 unsigned correct_single_bit_error(unsigned code)
  61 {
  62         unsigned parity_diff = generate_parity(code >> PARITY_BITS) ^ code;
  63         unsigned bp = 0, i;
  64
  65         for (i = 0; i < PARITY_BITS - 1; ++i) {
  66                 if (parity_diff & (1 << (PARITY_BITS - 1 - i))) {
  67                         bp |= (1 << i);
  68                 }
  69         }
  70
  71         if (bp != 0) {
  72                 /* flip the wrong bit */
  73                 code ^= (1 << permutation_table[bp]);
  74         }
  75
  76         /* recompute the lower parity */
  77         return (code & ~1) | find_parity_32(code & ~1);
  78 }
  79
  80 void check_zero_bit_detection()
  81 {
  82         unsigned i;
  83         printf("Checking zero bit detection.");
  84         fflush(stdout);
  85
  86         for (i = 0; i < NUM_DATA_WORDS; ++i) {
  87                 unsigned code = make_codeword(i);
  88
  89                 if ((i & 0xfffff) == 0) {
  90                         printf(".");
  91                         fflush(stdout);
  92                 }
  93
  94                 if (has_error(code)) {
  95                         printf("ERROR: Failed zero-bit test 1 for %x\n", i);
  96                 }
  97                 if (has_double_error(code)) {
  98                         printf("ERROR: Failed zero-bit test 2 for %x\n", i);
  99                 }
 100         }
 101
 102         printf("\n");
 103 }
 104
 105 void check_single_bit_detection()
 106 {
 107         unsigned i, j;
 108         printf("Checking single bit detection and correction.");
 109         fflush(stdout);
 110
 111         for (i = 0; i < NUM_DATA_WORDS; ++i) {
 112                 unsigned code = make_codeword(i);
 113
 114                 if ((i & 0xfffff) == 0) {
 115                         printf(".");
 116                         fflush(stdout);
 117                 }
 118
 119                 for (j = 0; j < CODE_BITS; ++j) {
 120                         unsigned corrupted_code = code ^ (1 << j);
 121
 122                         if (!has_error(corrupted_code)) {
 123                                 printf("ERROR: Failed single-bit test 1 for %x with bit %u flipped\n", i, j);
 124                         }
 125                         if (has_double_error(corrupted_code)) {
 126                                 printf("ERROR: Failed single-bit test 2 for %x with bit %u flipped\n", i, j);
 127                         }
 128                         if (correct_single_bit_error(corrupted_code) != code) {
 129                                 printf("ERROR: Failed single-bit correction test for %x with bit %u flipped\n", i, j);
 130                         }
 131                 }
 132         }
 133
 134         printf("\n");
 135 }
 136
 137 void check_double_bit_detection()
 138 {
 139         unsigned i, j, k;
 140         printf("Checking double bit detection.");
 141         fflush(stdout);
 142
 143         for (i = 0; i < NUM_DATA_WORDS; ++i) {
 144                 unsigned code = make_codeword(i);
 145
 146                 if ((i & 0xfffff) == 0) {
 147                         printf(".");
 148                         fflush(stdout);
 149                 }
 150
 151                 for (j = 0; j < CODE_BITS; ++j) {
 152                         for (k = 0; k < CODE_BITS; ++k) {
 153                                 unsigned corrupted_code = code ^ (1 << j) ^ (1 << k);
 154                                 if (j == k)
 155                                         continue;
 156
 157                                 if (!has_error(corrupted_code)) {
 158                                         printf("ERROR: Failed double-bit test 1 for %x with bit %u and %u flipped\n", i, j, k);
 159                                 }
 160                                 if (!has_double_error(corrupted_code)) {
 161                                         printf("ERROR: Failed double-bit test 2 for %x with bit %u and %u flipped\n", i, j, k);
 162                                 }
 163                         }
 164                 }
 165         }
 166
 167         printf("\n");
 168 }
 169
 170 int main()
 171 {
 172         check_zero_bit_detection();
 173         check_single_bit_detection();
 174         check_double_bit_detection();
 175
 176         return 0;
 177 }