Fourth Woods Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Uninitialized Variables ======

====== Unchecked Return Values ======
  * When developing an algorithm, developers tend to focus attention on the "good" path, the path that leads to the desired result.
  * The failure paths are given lower priority or forgotten about.
    * Effort is spent on getting the algorithm correct with the intent to go back and add error checking.
    * Once the algorithm is working schedule/deadlines may make moving on to a new task seem like a good idea.
  * Always checking for error conditions while developing the "good" path is distracting to the developer.
    * Each time the developer encounters a potential failure point they are no longer thinking about the algorithm at hand but how to handle this error and whether or not it can be recovered gracefully or if the program should be aborted.
    * Once the error condition is handled, the developer must "ramp up" again on where he left off on the "good" path.
    * It becomes very tempting to put off error handling to later, at which point it is easily neglected.

If you are going to put off error handling, don't just put in a "TODO" comment and expect to come back to it. Instead, do something that will force you to fix it.
<code cpp>
#define FAIL()  \
   do {         \
      fprintf(stderr, "abort! file: %s, line %d\n", __FILE__, __LINE__); \
      abort(0); \
   } while(0)
</code>
Then stub out your error checking:
<code cpp>
if(foo() == ERROR)
{
   FAIL(); // force immediate abort if this is never fixed.
}
</code>

===== Function returns the same value for success or failure =====


====== Buffer Overflows ======

====== Memory Leaks ======

====== Memory Allocation ======
<code cpp>
#ifdef CHECK_ALLOC
#define MALLOC bad_malloc
#else
#define MALLOC malloc
#endif

#define FAIL_COUNT = 3;
void* bad_malloc(size_t size)
{
   static int fail = FAIL_COUNT;
   void* ret = NULL;
   if(--fail)
      ret = malloc(size);
   else
      fail = FAIL_COUNT;
   return ret;
}
</code>

====== Heap Corruption ======

===== Electric Fence =====
<code bash>
$ gcc -o foo foo.c -lefence
</code>

====== Race Conditions ======

====== Code Coverage ======
<code bash>
$ gcc -ftest-coverage -fprofile-arcs foo.c
$ gcov foo.c
</code>

====== Automated Tools ======
<code bash>
$ splint -I/inc *.c
</code>