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 /* Search no more than N bytes of S for C.  */
  24
  25 char *
  26 memchr (s, c, n)
  27      unsigned char *s;
  28      int c;
  29      unsigned n;
  30 {
  31   const unsigned char *char_ptr;
  32   const unsigned long int *longword_ptr;
  33   unsigned long int longword, magic_bits, charmask;
  34
  35   c = (unsigned char) c;
  36
  37   /* Handle the first few characters by reading one character at a time.
  38      Do this until CHAR_PTR is aligned on a longword boundary.  */
  39   for (char_ptr = s; n > 0 && ((unsigned long int) char_ptr
  40                                & (sizeof (longword) - 1)) != 0;
  41        --n, ++char_ptr)
  42     if (*char_ptr == c)
  43       return (char *) char_ptr;
  44
  45   /* All these elucidatory comments refer to 4-byte longwords,
  46      but the theory applies equally well to 8-byte longwords.  */
  47
  48   longword_ptr = (unsigned long int *) char_ptr;
  49
  50   /* Bits 31, 24, 16, and 8 of this number are zero.  Call these bits
  51      the "holes."  Note that there is a hole just to the left of
  52      each byte, with an extra at the end:
  53
  54      bits:  01111110 11111110 11111110 11111111
  55      bytes: AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD
  56
  57      The 1-bits make sure that carries propagate to the next 0-bit.
  58      The 0-bits provide holes for carries to fall into.  */
  59 #ifdef LONG_64_BITS
  60   /* 64-bit version of the magic.  */
  61   magic_bits = ((unsigned long int) 0x7efefefe << 32) | 0xfefefeff;
  62 #else
  63   magic_bits = 0x7efefeff;
  64 #endif /* LONG_64_BITS */
  65
  66   /* Set up a longword, each of whose bytes is C.  */
  67   charmask = c | (c << 8);
  68   charmask |= charmask << 16;
  69 #ifdef LONG_64_BITS
  70   charmask |= charmask << 32;
  71 #endif /* LONG_64_BITS */
  72   if (sizeof (longword) > 8)
  73     abort ();
  74
  75
  76   /* Instead of the traditional loop which tests each character,
  77      we will test a longword at a time.  The tricky part is testing
  78      if *any of the four* bytes in the longword in question are zero.  */
  79   while (n >= sizeof (longword))
  80     {
  81       /* We tentatively exit the loop if adding MAGIC_BITS to
  82          LONGWORD fails to change any of the hole bits of LONGWORD.
  83
  84          1) Is this safe?  Will it catch all the zero bytes?
  85          Suppose there is a byte with all zeros.  Any carry bits
  86          propagating from its left will fall into the hole at its
  87          least significant bit and stop.  Since there will be no
  88          carry from its most significant bit, the LSB of the
  89          byte to the left will be unchanged, and the zero will be
  90          detected.
  91
  92          2) Is this worthwhile?  Will it ignore everything except
  93          zero bytes?  Suppose every byte of LONGWORD has a bit set
  94          somewhere.  There will be a carry into bit 8.  If bit 8
  95          is set, this will carry into bit 16.  If bit 8 is clear,
  96          one of bits 9-15 must be set, so there will be a carry
  97          into bit 16.  Similarly, there will be a carry into bit
  98          24.  If one of bits 24-30 is set, there will be a carry
  99          into bit 31, so all of the hole bits will be changed.
 100
 101          The one misfire occurs when bits 24-30 are clear and bit
 102          31 is set; in this case, the hole at bit 31 is not
 103          changed.  If we had access to the processor carry flag,
 104          we could close this loophole by putting the fourth hole
 105          at bit 32!
 106
 107          So it ignores everything except 128's, when they're aligned
 108          properly.
 109
 110          3) But wait!  Aren't we looking for C, not zero?
 111          Good point.  So what we do is XOR LONGWORD with a longword,
 112          each of whose bytes is C.  This turns each byte that is C
 113          into a zero.  */
 114
 115       longword = *longword_ptr++ ^ charmask;
 116
 117       /* Add MAGIC_BITS to LONGWORD.  */
 118       if ((((longword + magic_bits)
 119
 120       /* Set those bits that were unchanged by the addition.  */
 121             ^ ~longword)
 122
 123       /* Look at only the hole bits.  If any of the hole bits
 124               are unchanged, most likely one of the bytes was a
 125               zero.  */
 126            & ~magic_bits) != 0)
 127         {
 128           /* Which of the bytes was C?  If none of them were, it was
 129              a misfire; continue the search.  */
 130
 131           const unsigned char *cp = (const unsigned char *) (longword_ptr - 1);
 132
 133           if (cp[0] == c)
 134             return (char *) cp;
 135           if (cp[1] == c)
 136             return (char *) &cp[1];
 137           if (cp[2] == c)
 138             return (char *) &cp[2];
 139           if (cp[3] == c)
 140             return (char *) &cp[3];
 141 #ifdef LONG_64_BITS
 142           if (cp[4] == c)
 143             return (char *) &cp[4];
 144           if (cp[5] == c)
 145             return (char *) &cp[5];
 146           if (cp[6] == c)
 147             return (char *) &cp[6];
 148           if (cp[7] == c)
 149             return (char *) &cp[7];
 150 #endif /* LONG_64_BITS */
 151         }
 152
 153       n -= sizeof (longword);
 154     }
 155
 156   char_ptr = (const unsigned char *) longword_ptr;
 157
 158   while (n-- > 0)
 159     {
 160       if (*char_ptr == c)
 161         return (char *) char_ptr;
 162       else
 163         ++char_ptr;
 164     }
 165
 166   return 0;
 167 }