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