Re: A case for `void *' for pointers to arbitrary (byte) buffers

[Mark Kettenis <mark.kettenis@xs4all.nl>]

   Date: Tue, 3 May 2005 17:16:46 -0400
   From: Daniel Jacobowitz <drow@false.org>

   On Tue, May 03, 2005 at 11:13:24PM +0200, Mark Kettenis wrote:
   >    Date: Tue, 3 May 2005 16:23:52 -0400
   >    From: Daniel Jacobowitz <drow@false.org>
   > 
   >    > Why not use `xxx_byte *' instead of `void *'?
   >    > ---------------------------------------------
   >    > 
   >    > * It's nonstandard.  Why do we need a nonstandard type if a perfectly
   >    >   god standard type is available?
   >    > 
   >    > * It doesn't really solve the issue.  It only propagates the problem
   >    >   one level up or down.  Since `xxx_byte *' is nothing but a typedef
   >    >   for `unsigned char *', someone calling a functions with `xxx_byte *'
   >    >   as one of its arguments with a `char *' argument will suffer from
   >    >   the warning that raised this entire issue; `void *' breaks the chain
   >    >   immediately.
   > 
   >    I think that's a bad thing!  For the same reason that we use -Werror:
   >    where possible, we can let GCC enforce consistency within our source
   >    base.  Use of gdb_byte (as unsigned char) buys you the advantage that
   >    any other pointer type won't silently convert to it.
   > 
   > Ah, but these are supposed to be opaque blobs of memory.

   That's my point.  This way we can only pass "opaque blobs of memory" to
   the interfaces that want opaque blobs.  It's a question of
   categorization.  For instance, this is a bug:

     long foo;
     target_read_memory (addr, &foo, 4);

   If the second argument is "void *", a C compiler won't complain about
   this.  But for "uint8_t *", it will.

Hmm, you have a point here...

   >    If you want to use a standard type, play the necessary autoconf games
   >    to acquire stdint.h.  Use uint8_t *.
   > 
   > That's an interesting suggestion.  It might take a few iterations to
   > get that right though.

   I'm willing to do the work.

OK great!  I really like being able to use those (u)intN_t types, and
especially (u)intptr_t.  You can probably steal the autoconf checks
from GNU coreutils.  Those will have been pretty well tested I sppose.
But the base sequence should something like:

#ifdef HAVE_STDINT_H
#include <stdint.h>
#else
# ifdef HAVE_INTTYPES_H
# include <inttypes.h>
# else
typedef unsigned char uint8_t;
# endif
#endif

Mark