Blame lib/memchr.c

Packit Service fdd496
/* Copyright (C) 1991, 1993, 1996-1997, 1999-2000, 2003-2004, 2006, 2008-2017
Packit Service fdd496
   Free Software Foundation, Inc.
Packit Service fdd496
Packit Service fdd496
   Based on strlen implementation by Torbjorn Granlund (tege@sics.se),
Packit Service fdd496
   with help from Dan Sahlin (dan@sics.se) and
Packit Service fdd496
   commentary by Jim Blandy (jimb@ai.mit.edu);
Packit Service fdd496
   adaptation to memchr suggested by Dick Karpinski (dick@cca.ucsf.edu),
Packit Service fdd496
   and implemented by Roland McGrath (roland@ai.mit.edu).
Packit Service fdd496
Packit Service fdd496
NOTE: The canonical source of this file is maintained with the GNU C Library.
Packit Service fdd496
Bugs can be reported to bug-glibc@prep.ai.mit.edu.
Packit Service fdd496
Packit Service fdd496
This program is free software: you can redistribute it and/or modify it
Packit Service fdd496
under the terms of the GNU General Public License as published by the
Packit Service fdd496
Free Software Foundation; either version 3 of the License, or any
Packit Service fdd496
later version.
Packit Service fdd496
Packit Service fdd496
This program is distributed in the hope that it will be useful,
Packit Service fdd496
but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service fdd496
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service fdd496
GNU General Public License for more details.
Packit Service fdd496
Packit Service fdd496
You should have received a copy of the GNU General Public License
Packit Service fdd496
along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
Packit Service fdd496
Packit Service fdd496
#ifndef _LIBC
Packit Service fdd496
# include <config.h>
Packit Service fdd496
#endif
Packit Service fdd496
Packit Service fdd496
#include <string.h>
Packit Service fdd496
Packit Service fdd496
#include <stddef.h>
Packit Service fdd496
Packit Service fdd496
#if defined _LIBC
Packit Service fdd496
# include <memcopy.h>
Packit Service fdd496
#else
Packit Service fdd496
# define reg_char char
Packit Service fdd496
#endif
Packit Service fdd496
Packit Service fdd496
#include <limits.h>
Packit Service fdd496
Packit Service fdd496
#if HAVE_BP_SYM_H || defined _LIBC
Packit Service fdd496
# include <bp-sym.h>
Packit Service fdd496
#else
Packit Service fdd496
# define BP_SYM(sym) sym
Packit Service fdd496
#endif
Packit Service fdd496
Packit Service fdd496
#undef __memchr
Packit Service fdd496
#ifdef _LIBC
Packit Service fdd496
# undef memchr
Packit Service fdd496
#endif
Packit Service fdd496
Packit Service fdd496
#ifndef weak_alias
Packit Service fdd496
# define __memchr memchr
Packit Service fdd496
#endif
Packit Service fdd496
Packit Service fdd496
/* Search no more than N bytes of S for C.  */
Packit Service fdd496
void *
Packit Service fdd496
__memchr (void const *s, int c_in, size_t n)
Packit Service fdd496
{
Packit Service fdd496
  /* On 32-bit hardware, choosing longword to be a 32-bit unsigned
Packit Service fdd496
     long instead of a 64-bit uintmax_t tends to give better
Packit Service fdd496
     performance.  On 64-bit hardware, unsigned long is generally 64
Packit Service fdd496
     bits already.  Change this typedef to experiment with
Packit Service fdd496
     performance.  */
Packit Service fdd496
  typedef unsigned long int longword;
Packit Service fdd496
Packit Service fdd496
  const unsigned char *char_ptr;
Packit Service fdd496
  const longword *longword_ptr;
Packit Service fdd496
  longword repeated_one;
Packit Service fdd496
  longword repeated_c;
Packit Service fdd496
  unsigned reg_char c;
Packit Service fdd496
Packit Service fdd496
  c = (unsigned char) c_in;
Packit Service fdd496
Packit Service fdd496
  /* Handle the first few bytes by reading one byte at a time.
Packit Service fdd496
     Do this until CHAR_PTR is aligned on a longword boundary.  */
Packit Service fdd496
  for (char_ptr = (const unsigned char *) s;
Packit Service fdd496
       n > 0 && (size_t) char_ptr % sizeof (longword) != 0;
Packit Service fdd496
       --n, ++char_ptr)
Packit Service fdd496
    if (*char_ptr == c)
Packit Service fdd496
      return (void *) char_ptr;
Packit Service fdd496
Packit Service fdd496
  longword_ptr = (const longword *) char_ptr;
Packit Service fdd496
Packit Service fdd496
  /* All these elucidatory comments refer to 4-byte longwords,
Packit Service fdd496
     but the theory applies equally well to any size longwords.  */
Packit Service fdd496
Packit Service fdd496
  /* Compute auxiliary longword values:
Packit Service fdd496
     repeated_one is a value which has a 1 in every byte.
Packit Service fdd496
     repeated_c has c in every byte.  */
Packit Service fdd496
  repeated_one = 0x01010101;
Packit Service fdd496
  repeated_c = c | (c << 8);
Packit Service fdd496
  repeated_c |= repeated_c << 16;
Packit Service fdd496
  if (0xffffffffU < (longword) -1)
Packit Service fdd496
    {
Packit Service fdd496
      repeated_one |= repeated_one << 31 << 1;
Packit Service fdd496
      repeated_c |= repeated_c << 31 << 1;
Packit Service fdd496
      if (8 < sizeof (longword))
Packit Service fdd496
        {
Packit Service fdd496
          size_t i;
Packit Service fdd496
Packit Service fdd496
          for (i = 64; i < sizeof (longword) * 8; i *= 2)
Packit Service fdd496
            {
Packit Service fdd496
              repeated_one |= repeated_one << i;
Packit Service fdd496
              repeated_c |= repeated_c << i;
Packit Service fdd496
            }
Packit Service fdd496
        }
Packit Service fdd496
    }
Packit Service fdd496
Packit Service fdd496
  /* Instead of the traditional loop which tests each byte, we will test a
Packit Service fdd496
     longword at a time.  The tricky part is testing if *any of the four*
Packit Service fdd496
     bytes in the longword in question are equal to c.  We first use an xor
Packit Service fdd496
     with repeated_c.  This reduces the task to testing whether *any of the
Packit Service fdd496
     four* bytes in longword1 is zero.
Packit Service fdd496
Packit Service fdd496
     We compute tmp =
Packit Service fdd496
       ((longword1 - repeated_one) & ~longword1) & (repeated_one << 7).
Packit Service fdd496
     That is, we perform the following operations:
Packit Service fdd496
       1. Subtract repeated_one.
Packit Service fdd496
       2. & ~longword1.
Packit Service fdd496
       3. & a mask consisting of 0x80 in every byte.
Packit Service fdd496
     Consider what happens in each byte:
Packit Service fdd496
       - If a byte of longword1 is zero, step 1 and 2 transform it into 0xff,
Packit Service fdd496
         and step 3 transforms it into 0x80.  A carry can also be propagated
Packit Service fdd496
         to more significant bytes.
Packit Service fdd496
       - If a byte of longword1 is nonzero, let its lowest 1 bit be at
Packit Service fdd496
         position k (0 <= k <= 7); so the lowest k bits are 0.  After step 1,
Packit Service fdd496
         the byte ends in a single bit of value 0 and k bits of value 1.
Packit Service fdd496
         After step 2, the result is just k bits of value 1: 2^k - 1.  After
Packit Service fdd496
         step 3, the result is 0.  And no carry is produced.
Packit Service fdd496
     So, if longword1 has only non-zero bytes, tmp is zero.
Packit Service fdd496
     Whereas if longword1 has a zero byte, call j the position of the least
Packit Service fdd496
     significant zero byte.  Then the result has a zero at positions 0, ...,
Packit Service fdd496
     j-1 and a 0x80 at position j.  We cannot predict the result at the more
Packit Service fdd496
     significant bytes (positions j+1..3), but it does not matter since we
Packit Service fdd496
     already have a non-zero bit at position 8*j+7.
Packit Service fdd496
Packit Service fdd496
     So, the test whether any byte in longword1 is zero is equivalent to
Packit Service fdd496
     testing whether tmp is nonzero.  */
Packit Service fdd496
Packit Service fdd496
  while (n >= sizeof (longword))
Packit Service fdd496
    {
Packit Service fdd496
      longword longword1 = *longword_ptr ^ repeated_c;
Packit Service fdd496
Packit Service fdd496
      if ((((longword1 - repeated_one) & ~longword1)
Packit Service fdd496
           & (repeated_one << 7)) != 0)
Packit Service fdd496
        break;
Packit Service fdd496
      longword_ptr++;
Packit Service fdd496
      n -= sizeof (longword);
Packit Service fdd496
    }
Packit Service fdd496
Packit Service fdd496
  char_ptr = (const unsigned char *) longword_ptr;
Packit Service fdd496
Packit Service fdd496
  /* At this point, we know that either n < sizeof (longword), or one of the
Packit Service fdd496
     sizeof (longword) bytes starting at char_ptr is == c.  On little-endian
Packit Service fdd496
     machines, we could determine the first such byte without any further
Packit Service fdd496
     memory accesses, just by looking at the tmp result from the last loop
Packit Service fdd496
     iteration.  But this does not work on big-endian machines.  Choose code
Packit Service fdd496
     that works in both cases.  */
Packit Service fdd496
Packit Service fdd496
  for (; n > 0; --n, ++char_ptr)
Packit Service fdd496
    {
Packit Service fdd496
      if (*char_ptr == c)
Packit Service fdd496
        return (void *) char_ptr;
Packit Service fdd496
    }
Packit Service fdd496
Packit Service fdd496
  return NULL;
Packit Service fdd496
}
Packit Service fdd496
#ifdef weak_alias
Packit Service fdd496
weak_alias (__memchr, BP_SYM (memchr))
Packit Service fdd496
#endif