Initial revision
[kopensolaris-gnu/glibc.git] / sysdeps / generic / strchr.c
1 /* Copyright (C) 1991 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    bug fix and commentary by Jim Blandy (jimb@ai.mit.edu);
5    adaptation to strchr suggested by Dick Karpinski (dick@cca.ucsf.edu),
6    and implemented by Roland McGrath (roland@ai.mit.edu).
7
8 This file is part of the GNU C Library.
9
10 The GNU C Library is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 1, or (at your option)
13 any later version.
14
15 The GNU C Library is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with the GNU C Library; see the file COPYING.  If not, write to
22 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
23
24 #include <ansidecl.h>
25 #include <string.h>
26
27
28 /* Find the first ocurrence of C in S.  */
29
30 char *
31 DEFUN(strchr, (s, c), CONST char *s AND int c)
32 {
33   CONST unsigned char *char_ptr;
34   CONST unsigned long int *longword_ptr;
35   unsigned long int longword, magic_bits, charmask;
36
37   c = (unsigned char) c;
38
39   /* Handle the first few characters by reading one character at a time.
40      Do this until CHAR_PTR is aligned on a 4-byte border.  */
41   for (char_ptr = (CONST unsigned char *) s;
42        ((unsigned long int) char_ptr & 3) != 0; ++char_ptr)
43     {
44       if (*char_ptr == c)
45         return (char *) char_ptr;
46       else if (*char_ptr == '\0')
47         return NULL;
48     }
49
50   longword_ptr = (unsigned long int *) char_ptr;
51
52   /* Bits 31, 24, 16, and 8 of this number are zero.  Call these bits
53      the "holes."  Note that there is a hole just to the left of
54      each byte, with an extra at the end:
55      
56      bits:  01111110 11111110 11111110 11111111
57      bytes: AAAAAAAA BBBBBBBB CCCCCCCC DDDDDDDD 
58
59      The 1-bits make sure that carries propagate to the next 0-bit.
60      The 0-bits provide holes for carries to fall into.  */
61   magic_bits = 0x7efefeff;
62
63   /* Set up a longword, each of whose bytes is C.  */
64   charmask = (c << 24) | (c << 16) | (c << 8) | c;
65
66   /* Instead of the traditional loop which tests each character,
67      we will test a longword at a time.  The tricky part is testing
68      if *any of the four* bytes in the longword in question are zero.  */
69   for (;;)
70     {
71       /* We tentatively exit the loop if adding MAGIC_BITS to
72          LONGWORD fails to change any of the hole bits of LONGWORD.
73
74          1) Is this safe?  Will it catch all the zero bytes?
75          Suppose there is a byte with all zeros.  Any carry bits
76          propagating from its left will fall into the hole at its
77          least significant bit and stop.  Since there will be no
78          carry from its most significant bit, the LSB of the
79          byte to the left will be unchanged, and the zero will be
80          detected.
81
82          2) Is this worthwhile?  Will it ignore everything except
83          zero bytes?  Suppose every byte of LONGWORD has a bit set
84          somewhere.  There will be a carry into bit 8.  If bit 8
85          is set, this will carry into bit 16.  If bit 8 is clear,
86          one of bits 9-15 must be set, so there will be a carry
87          into bit 16.  Similarly, there will be a carry into bit
88          24.  If one of bits 24-30 is set, there will be a carry
89          into bit 31, so all of the hole bits will be changed.
90
91          The one misfire occurs when bits 24-30 are clear and bit
92          31 is set; in this case, the hole at bit 31 is not
93          changed.  If we had access to the processor carry flag,
94          we could close this loophole by putting the fourth hole
95          at bit 32!
96
97          So it ignores everything except 128's, when they're aligned
98          properly.
99
100          3) But wait!  Aren't we looking for C as well as zero?
101          Good point.  So what we do is XOR LONGWORD with a longword,
102          each of whose bytes is C.  This turns each byte that is C
103          into a zero.  */
104
105       longword = *longword_ptr++;
106
107       /* Add MAGIC_BITS to LONGWORD.  */
108       if ((((longword + magic_bits)
109         
110             /* Set those bits that were unchanged by the addition.  */
111             ^ ~longword)
112                
113            /* Look at only the hole bits.  If any of the hole bits
114               are unchanged, most likely one of the bytes was a
115               zero.  */
116            & ~magic_bits) != 0 ||
117
118           /* That caught zeroes.  Now test for C.  */
119           ((((longword ^ charmask) + magic_bits) ^ ~(longword ^ charmask))
120            & ~magic_bits) != 0)
121         {
122           /* Which of the bytes was C or zero?
123              If none of them were, it was a misfire; continue the search.  */
124
125           CONST unsigned char *cp = (CONST unsigned char *) (longword_ptr - 1);
126
127           if (*cp == c)
128             return (char *) cp;
129           else if (*cp == '\0')
130             return NULL;
131           if (*++cp == c)
132             return (char *) cp;
133           else if (*cp == '\0')
134             return NULL;
135           if (*++cp == c)
136             return (char *) cp;
137           else if (*cp == '\0')
138             return NULL;
139           if (*++cp == c)
140             return (char *) cp;
141           else if (*cp == '\0')
142             return NULL;
143         }
144     }
145
146   return NULL;
147 }