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