Blame lib/memchr.c

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