lib/memchr.c

   1 /* Copyright (C) 1991, 1993 Free Software Foundation, Inc.
   2    Based on strlen implemention by Torbjorn Granlund (tege@sics.se),
   3    with help from Dan Sahlin (dan@sics.se) and
   4    commentary by Jim Blandy (jimb@ai.mit.edu);
   5    adaptation to memchr suggested by Dick Karpinski (dick@cca.ucsf.edu),
   6    and implemented by Roland McGrath (roland@ai.mit.edu).
   7
   8 The GNU C Library is free software; you can redistribute it and/or
   9 modify it under the terms of the GNU Library General Public License as
  10 published by the Free Software Foundation; either version 2 of the
  11 License, or (at your option) any later version.
  12
  13 The GNU C Library is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 Library General Public License for more details.
  17
  18 You should have received a copy of the GNU Library General Public
  19 License along with the GNU C Library; see the file COPYING.LIB.  If
  20 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
  21 Cambridge, MA 02139, USA.  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #if defined (CONFIG_BROKETS)
  25 /* We use <config.h> instead of "config.h" so that a compilation
  26    using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
  27    (which it would do because it found this file in $srcdir).  */
  28 #include <config.h>
  29 #else
  30 #include "config.h"
  31 #endif
  32 #endif
  33
  34 #if (SIZEOF_LONG != 4 && SIZEOF_LONG != 8)
  35  error This function works only on systems for which sizeof(long) is 4 or 8.
  36 /* The previous line would begin with `#error,' but some compilers can't
  37    handle that even when the condition is false.  */
  38 #endif
  39
  40 /* Search no more than N bytes of S for C.  */
  41
  42 char *
  43 memchr (s, c, n)
  44      unsigned char *s;
  45      int c;
  46      unsigned n;
  47 {
  48   const unsigned char *char_ptr;
  49   const unsigned long int *longword_ptr;
  50   unsigned long int longword, magic_bits, charmask;
  51
  52   c = (unsigned char) c;
  53
  54   /* Handle the first few characters by reading one character at a time.
  55      Do this until CHAR_PTR is aligned on a longword boundary.  */
  56   for (char_ptr = s; n > 0 && ((unsigned long int) char_ptr
  57                                & (sizeof (longword) - 1)) != 0;
  58        --n, ++char_ptr)
  59     if (*char_ptr == c)
  60       return (char *) char_ptr;
  61
  62   /* All these elucidatory comments refer to 4-byte longwords,
  63      but the theory applies equally well to 8-byte longwords.  */
  64
  65   longword_ptr = (unsigned long int *) char_ptr;
  66
  67   /* Bits 31, 24, 16, and 8 of this number are zero.  Call these bits
  68      the "holes."  Note that there is a hole just to the left of
  69      each byte, with an extra at the end:
  70
  71      bits:  01111110 11111110 11111110 11111111
  72      bytes: AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD
  73
  74      The 1-bits make sure that carries propagate to the next 0-bit.
  75      The 0-bits provide holes for carries to fall into.  */
  76 #if (SIZEOF_LONG == 8)
  77   magic_bits = ((unsigned long int) 0x7efefefe << 32) | 0xfefefeff;
  78 #else
  79   magic_bits = 0x7efefeff;
  80 #endif /* SIZEOF_LONG == 8 */
  81
  82   /* Set up a longword, each of whose bytes is C.  */
  83   charmask = c | (c << 8);
  84   charmask |= charmask << 16;
  85 #if (SIZEOF_LONG == 8)
  86   charmask |= charmask << 32;
  87 #endif /* SIZEOF_LONG == 8 */
  88   if (sizeof (longword) > 8)
  89     abort ();
  90
  91
  92   /* Instead of the traditional loop which tests each character,
  93      we will test a longword at a time.  The tricky part is testing
  94      if *any of the four* bytes in the longword in question are zero.  */
  95   while (n >= sizeof (longword))
  96     {
  97       /* We tentatively exit the loop if adding MAGIC_BITS to
  98          LONGWORD fails to change any of the hole bits of LONGWORD.
  99
 100          1) Is this safe?  Will it catch all the zero bytes?
 101          Suppose there is a byte with all zeros.  Any carry bits
 102          propagating from its left will fall into the hole at its
 103          least significant bit and stop.  Since there will be no
 104          carry from its most significant bit, the LSB of the
 105          byte to the left will be unchanged, and the zero will be
 106          detected.
 107
 108          2) Is this worthwhile?  Will it ignore everything except
 109          zero bytes?  Suppose every byte of LONGWORD has a bit set
 110          somewhere.  There will be a carry into bit 8.  If bit 8
 111          is set, this will carry into bit 16.  If bit 8 is clear,
 112          one of bits 9-15 must be set, so there will be a carry
 113          into bit 16.  Similarly, there will be a carry into bit
 114          24.  If one of bits 24-30 is set, there will be a carry
 115          into bit 31, so all of the hole bits will be changed.
 116
 117          The one misfire occurs when bits 24-30 are clear and bit
 118          31 is set; in this case, the hole at bit 31 is not
 119          changed.  If we had access to the processor carry flag,
 120          we could close this loophole by putting the fourth hole
 121          at bit 32!
 122
 123          So it ignores everything except 128's, when they're aligned
 124          properly.
 125
 126          3) But wait!  Aren't we looking for C, not zero?
 127          Good point.  So what we do is XOR LONGWORD with a longword,
 128          each of whose bytes is C.  This turns each byte that is C
 129          into a zero.  */
 130
 131       longword = *longword_ptr++ ^ charmask;
 132
 133       /* Add MAGIC_BITS to LONGWORD.  */
 134       if ((((longword + magic_bits)
 135
 136       /* Set those bits that were unchanged by the addition.  */
 137             ^ ~longword)
 138
 139       /* Look at only the hole bits.  If any of the hole bits
 140               are unchanged, most likely one of the bytes was a
 141               zero.  */
 142            & ~magic_bits) != 0)
 143         {
 144           /* Which of the bytes was C?  If none of them were, it was
 145              a misfire; continue the search.  */
 146
 147           const unsigned char *cp = (const unsigned char *) (longword_ptr - 1);
 148
 149           if (cp[0] == c)
 150             return (char *) cp;
 151           if (cp[1] == c)
 152             return (char *) &cp[1];
 153           if (cp[2] == c)
 154             return (char *) &cp[2];
 155           if (cp[3] == c)
 156             return (char *) &cp[3];
 157 #if (SIZEOF_LONG == 8)
 158           if (cp[4] == c)
 159             return (char *) &cp[4];
 160           if (cp[5] == c)
 161             return (char *) &cp[5];
 162           if (cp[6] == c)
 163             return (char *) &cp[6];
 164           if (cp[7] == c)
 165             return (char *) &cp[7];
 166 #endif /* SIZEOF_LONG == 8 */
 167         }
 168
 169       n -= sizeof (longword);
 170     }
 171
 172   char_ptr = (const unsigned char *) longword_ptr;
 173
 174   while (n-- > 0)
 175     {
 176       if (*char_ptr == c)
 177         return (char *) char_ptr;
 178       else
 179         ++char_ptr;
 180     }
 181
 182   return 0;
 183 }